localization

GET /v1/i18n/documents/{locale}

Get one marketing document's finished translations.

Усі кінцеві точки localization

Уся документація для розробників

Автентифікація

Ця кінцева точка є публічною. Вона не потребує жодних облікових даних чи організації — це те, що читають наш власний маркетинговий сайт та пошукові системи на основі штучного інтелекту.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/i18n/documents/{locale}?object_ref=<object_ref>

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Returns the finished translations for a single document, as field -> text across the surfaces a rendered page is built from (page, meta_title, meta_description, alt_text) — the read the public site performs on the server, per page, at render time. Why a second public endpoint next to getPublicMessageCatalogue. They are cached on different keys and answer different questions. The catalogue is one response per locale covering the shell (nav, footer, meta) and is read on every page; this is one response per document per locale, read only by the page it belongs to. Folding them together would churn the shell's cache entry whenever any of 60 marketing pages was retranslated. object_ref is required. One locale's whole page surface is ~7,879 entries — the read scripts/i18n-pages.mjs batches at build time, and the one that OOM-killed the engine on 2026-08-05. Making the parameter optional would re-create that on a public, unauthenticated URL. A single document is ~131 leaves, which is what makes this safe on a render path behind an edge cache. Public and non-tenant, for the same reasons as the catalogue: the text is already in the page's HTML, and an Authorization header suppresses shared caching. up_to_date only — the site applies this over the document the current deploy already serves, so stale text could only replace a good translation with an older one. An untranslated document is a 200 with an empty fields object, never a 404 — the caller treats any failure as "use the build-time document", so a 404 would be indistinguishable from an outage. Cacheable: strong ETag plus Cache-Control: public, max-age=300, stale-while-revalidate=86400.

Параметри

НазваТипОбов'язковеЩо це таке
locale (path)LocaleCodeТакThe target locale (docs/28 registry code).
object_ref (query)stringТакThe document, e.g. page:hosting. Required — see the description.
If-None-Match (header)stringНіA previously returned ETag; a match responds 304.

Відповідь

НазваТипОбов'язковеЩо це таке
localeLocaleCodeТакBCP-47 / ISO locale code from the language registry (docs/28).
object_refstringТакThe document these fields belong to, echoed back.
fieldsobjectТакfield -> translated text, flat. The field names are the ones the CMS walker (cms/src/lib/snapshotKeys.ts) assigns when it collects a document's translatable leaves, so the…

Помилки, які може повертати ця кінцева точка

422 · 429