localization

GET `/v1/i18n/bundles/{locale}`

Get every translated string for one locale.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

curl -X GET https://api.zinndigital.com/v1/i18n/bundles/{locale} \
  -H "Authorization: Bearer zdk_live_…"

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

Returns the calling organization's translated strings for `locale`, grouped by `object_ref` then `field` — the read a site build or an SSR render performs to populate a locale. **Last-good-while-stale.** An entry's `text` is returned whenever it is non-empty, *regardless of its `status`*: the store retains the previous translation while a re-translation is in flight, and serving that is better than serving an English string (or nothing) on a localized page. The per-entry `status` is exposed so the caller decides — a production build may accept `stale`, a release gate may refuse anything that is not `up_to_date`. Entries with no text yet are omitted entirely rather than returned blank. **Deliberately NOT cursor-paginated — a documented deviation from the rest of this API.** Every other collection here is cursor-paginated, and that is the right default for tenant data that grows without bound. This corpus is different: it is our own bounded, self-owned content, read as a single unit at build time. Paginating it would turn one build into hundreds of sequential round-trips *per locale* (58 locales × pages), for no isolation or performance benefit. Instead the response is bounded by a hard server-side cap; a bundle that would exceed it is a `422` naming the cap and telling the caller to narrow with `surface` or `object_ref_prefix` rather than silently truncating. Cacheable: responses carry a strong `ETag` over the bundle contents plus `Cache-Control: public, max-age=60`. Send `If-None-Match` to get a `304` and skip the transfer entirely.

Parametri

Nume	Tip	Obligatoriu	Ce este
`locale (path)`	`LocaleCode`	Da	The target locale to build a bundle for (docs/28 registry code).
`surface (query)`	`string`	Nu	Comma-separated list of surfaces to include (e.g. `page,meta_title`). All surfaces when omitted. An unknown surface is a `422`.
`object_ref_prefix (query)`	`string`	Nu	Only include entries whose `object_ref` starts with this prefix (e.g. `kb_article:` or `page:pricing`). Narrows a bundle that would otherwise exceed the entry cap.
`object_ref (query)`	`string`	Nu	Comma-separated list of exact `object_ref` values (at most 100). Fetches a group of documents in one request. This exists because a prefix cannot express a group and one req…
`limit (query)`	`integer`	Nu	Page size. Sending this (or `cursor`) opts into paging; send neither and the response is the whole bundle, with the `422` above when it exceeds the cap. Clamped to the 5,000…
`cursor (query)`	`string`	Nu	The `next_cursor` from the previous page, passed back verbatim. Opaque — a cursor this endpoint did not issue is a `422`, never a silent restart, which would loop a caller forev…
`If-None-Match (header)`	`string`	Nu	A previously returned `ETag`; a match responds `304`.

Răspuns

Nume	Tip	Obligatoriu	Ce este
`locale`	`LocaleCode`	Da	BCP-47 / ISO locale code from the language registry (docs/28).
`generated_at`	`string`	Da	When this bundle was assembled (server time).
`entries`	`object`	Da	`object_ref` -> `field` -> the translated entry. Entries with no text yet are omitted rather than returned blank.
`next_cursor`	`string`	Nu	Pass back as `cursor` for the next page. `null` on the last page, and absent entirely unless the request opted into paging with `limit` or `cursor` — so a caller that never…

Erori pe care le poate returna acest punct final

401 · 403 · 422 · 429

GET /v1/i18n/bundles/{locale}