hosting

GET /v1/sites/{site_id}/translation

Whether this site is translated, and how far along it is.

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X GET https://api.zinndigital.com/v1/sites/{site_id}/translation \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

The state of Site Translation for one site: whether it is bought, which tier, how many words and documents we measured, when we last read the site, and per-locale progress. A site with no subscription is a 200, not a 404. The screen needs to render the offer, and "not bought" is an answer about a site that exists — returning 404 would make a site the customer owns look missing. locales[] reports every language with its own counts, and served says whether the customer has switched that language on for visitors. ⛔ translated and served are separate numbers on purpose: every tier translates every language, so a locale can be 100% translated and reach nobody because its owner has not enabled it. Merging them would report either a coverage figure nobody is served by, or a delivery figure that understates what is ready — the two mistakes docs/28 was rewritten to stop making. Readable whether or not the account is in good standing: a customer behind on an invoice may still see what they have already paid for. Requires sites.view.

Parametry

NazwaTypWymaganeCo to jest
site_id (path)UuidTak

Odpowiedź

NazwaTypWymaganeCo to jest
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
statestring<disabled, active, paused_standing, over_allowance>Takpaused_standing is its own state, not a flavour of disabled — the remedies differ and only one of them is the customer's to act on.
tierSiteTranslationTierTak
available_tiersSiteTranslationTier[]TakThe ladder, so the screen never hardcodes a price.
word_countintegerTakTranslatable words measured at the last read.
document_countintegerTak
last_extracted_atstringNieWhen we last successfully read the site. ⛔ Distinct from the attempt cursor the sweep keeps: a failed pass advances that and must not move this, or the screen would report a site…
last_errorstringNieWhy the last pass did nothing, in words the customer can act on.
localesSiteTranslationLocale[]Tak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404