hosting
POST /v1/sites/{site_id}/translation/sources
The site tells us every translatable string it has.
認証
ベアラー トークンとして API キーを送信します。キーには sites.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{site_id}/translation/sources \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "documents": <SiteTranslationSourceDocument[]> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The push counterpart of `refreshSiteTranslation`, and it exists because a REST read of a WordPress post returns four fields — title, body, excerpt, slug — and a site is made of far more than that. Product attributes, variation names, category descriptions, menu labels, image alt text and every SEO field Yoast or Rank Math keeps in post meta are invisible to that read, and between them they are most of the words a visitor actually looks at. The Zinn® Translate plugin runs inside WordPress, enumerates all of it, and submits it here. **This is a point of spend**, so it asks entitlement, good standing (`CLAUDE.md` §2.46) and the tier allowance before registering anything, exactly as the pull path does and through the same helper. A `402` means the account is on hold, or the site holds more words than the tier covers. **The submission is the complete inventory, not a delta**, and that is load-bearing: anything the site does NOT send is retired (`CLAUDE.md` §2.52), so a deleted page stops being translated instead of being paid for for ever. Sending a partial list therefore deletes the translations of everything you left out. Registration is idempotent at the same content hash, so re-submitting an unchanged site costs nothing. Requires `sites.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id (path) | Uuid | はい | — |
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. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
documents | SiteTranslationSourceDocument[] | はい | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
documents | integer | はい | — |
words | integer | はい | — |
fields_registered | integer | はい | — |
fields_retired | integer | はい | Sources removed because the site no longer has them. Reported rather than silent: a destructive step that says nothing is indistinguishable from one that did nothing. |
skipped_not_in_good_standing | boolean | いいえ | §2.46 — counted and surfaced, never silent. `documents: 0` because the account is on hold looks identical to a pass that could not see any work. |
refused | string | いいえ | Why nothing was read, empty when it was. |
このエンドポイントが返すエラー
401 · 402 · 403 · 404 · 422 · 429