Kanorio
Kanorio 開発者

API リファレンス

Globals

Content Delivery API: GET /globals/headers/{key}, GET /globals/footer

このページは英語のみです。API リファレンス、Webhook イベント、変更履歴は、コード内のフィールド名やエラーコードと揃えるため英語で提供しています。
Base URL https://{site}/api/v1ErrorsPagination

Global header navigation by key ('primary' or secondary header key) with siteSettings and assets

GET/globals/headers/{key}
betaNo auth

Parameters

  • keystring · pathrequired
  • localestring · query

    Locale for the header text and the site settings copy (address, hours, copyright, buttons). One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale.

Response 200

  • keystringrequired
  • isPrimarybooleanrequired
  • headerobjectrequired
  • siteSettingsobject | nullrequired
  • assetsobjectrequired

Errors

  • HEADER_NOT_FOUND 404
  • UNSUPPORTED_LOCALE 400
curl -X GET "https://{site}/api/v1/globals/headers/{key}"