localization

POST `/v1/i18n/sources`

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

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

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

Спробувати

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

curl -X POST https://api.zinndigital.com/v1/i18n/sources \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Деталі

Registers (or updates) source fields for auto-translation into every enabled locale (CLAUDE.md §2.19, docs/28). Each item is keyed by (surface, object_ref, field) within the calling organization; the org is taken from the credential and can never be set from the body. Batched by design. One CMS page save touches on the order of 150 translatable fields (body blocks, meta title/description, OpenGraph, JSON-LD text, alt text, breadcrumb labels, the slug). A per-field request would turn a single editorial save into 150 round-trips, so the endpoint takes up to 200 items per call; more than that is a 422 asking the caller to split the batch. Intrinsically idempotent — an Idempotency-Key is accepted but not needed. Registration is keyed on a SHA-256 of the source text: when the content hash is unchanged the call is a complete no-op (nothing is marked stale, no re-translation event is emitted, changed comes back false). Replaying the same batch therefore costs nothing and changes nothing, so unlike every other unsafe endpoint here this one needs no replay protection to be safe. The header is still accepted so that clients and generated SDKs can send it uniformly across all writes. Translation runs asynchronously afterwards — a successful response means the source is recorded and (if it changed) queued, never that any locale is translated yet. Poll GET /v1/i18n/bundles/{locale} or watch the translation.completed events.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`Idempotency-Key (header)`	`string`	Ні	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`items`	`TranslationSourceItem[]`	Ні	The source fields to register. Capped at 200 per request — a larger batch is a `422` telling the caller to split it. Optional so that a RETIREMENT-ONLY request is expressible: the…
`prune`	`TranslationPruneScope`	Ні	Retire every registered source inside this scope that is NOT named in `items` — the de-registration path (#735). Without it, a key deleted from the caller's catalogue leaves its…
`prune_namespace`	`TranslationNamespacePrune`	Ні	Retire every registered DOCUMENT under `ref_prefix` that is not named in `expected_refs`. `TranslationPruneScope` retires fields inside one document; this retires documents that…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`results`	`TranslationSourceResult[]`	Так	One result per submitted item, in the order submitted.
`retired`	`TranslationField[]`	Ні	Field names deleted by `prune`, sorted. Empty when `prune` was absent or nothing was stale. Reported rather than assumed: a destructive operation that returns no number is…
`retired_refs`	`ObjectRef[]`	Ні	`object_ref`s deleted by `prune_namespace`, sorted. Empty when `prune_namespace` was absent or nothing was dead. Kept separate from `retired` on purpose: a count of retired FIELDS…

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

401 · 403 · 422 · 429

POST /v1/i18n/sources