localization
GET /v1/i18n/bundles/{locale}
Get every translated string for one locale.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/i18n/bundles/{locale} \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
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.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
locale (path) | LocaleCode | 예 | The target locale to build a bundle for (docs/28 registry code). |
surface (query) | string | 아니요 | 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 | 아니요 | 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 | 아니요 | 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 | 아니요 | 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 | 아니요 | 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 | 아니요 | A previously returned `ETag`; a match responds `304`. |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
locale | LocaleCode | 예 | BCP-47 / ISO locale code from the language registry (docs/28). |
generated_at | string | 예 | When this bundle was assembled (server time). |
entries | object | 예 | `object_ref` -> `field` -> the translated entry. Entries with no text yet are omitted rather than returned blank. |
next_cursor | string | 아니요 | 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… |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 422 · 429