localization

GET /v1/i18n/documents/{locale}

Get one marketing document's finished translations.

Vituo vyote vya localization

Uthibitishaji

Kituo hiki cha mwisho ni cha umma. Hakichukui kitambulisho wala shirika — ni kile ambacho tovuti yetu ya masoko na injini za majibu za AI zinasoma.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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`.

Vigezo

JinaAinaInayohitajikaKilicho hiki
locale (path)LocaleCodeNdiyoThe target locale (docs/28 registry code).
object_ref (query)stringNdiyoThe document, e.g. `page:hosting`. Required — see the description.
If-None-Match (header)stringHapanaA previously returned `ETag`; a match responds `304`.

Majibu

JinaAinaInayohitajikaKilicho hiki
localeLocaleCodeNdiyoBCP-47 / ISO locale code from the language registry (docs/28).
object_refstringNdiyoThe document these fields belong to, echoed back.
fieldsobjectNdiyo`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 c…

Hitilafu ambazo mwisho huu unaweza kurudisha

422 · 429