Sada API volání je k dispozici, která umožňuje:
-
Integraci Phrase a jakéhokoli softwaru třetích stran (nástroje pro správu překladů, CMS atd.)
-
Vývoj pracovního stolu překladatele. CAT editor je postaven na veřejných API.
-
Vytvoření zcela nového nástroje nebo služby pomocí Phrase jako backendu.
Základní pracovní postup
Postupy a pracovní postup musí být pochopeny před použitím API. Doporučuje se být obeznámen s postupem v Phrase před implementací souvisejícího API.
Základní pracovní postup je:
-
Vytvořte TM, TB a volitelně přidejte strojový překladový nástroj.
-
Vytvořte projekt s připojeným TM/TB/strojovým překladovým nástrojem (pokud je to potřeba).
-
Uložte projekt jako šablonu projektu a znovu ji použijte k vytvoření nového překladového projektu.
-
Nahrajte svůj soubor k překladu do projektu (vytvořte zakázku).
-
Poté můžete analyzovat, předpřeložit nebo přiřadit zakázku překladateli .
Asynchronní API
Asynchronní API by měla být vždy preferována před jejich synchronními protějšky. Pokud voláte synchronní API, existuje šance na obdržení odpovědí s vypršením časového limitu při zpracování velkých dávkách souborů nebo dokonce jednoho velkého souboru. Synchronní API by měla být používána pouze pro malé soubory a malé měřítko integrace.
Polling
Po zavolání asynchronního API je přijata okamžitá odpověď včetně identifikátoru požadavku. Použijte tento identifikátor k ověření stavu žádosti voláním getAsyncRequest a kontrolou pole asyncResponse. Tento přístup s dotazováním může vést k několika getAsyncRequest voláním před obdržením asyncResponse, které není null.
Zpětné volání
Jako reakci na nevýhody přístupu s dotazováním na asynchronní žádosti je podpora zpětných volání ve všech asynchronních API podporována. Při volání asynchronní žádosti uveďte URL (v parametru callbackUrl), která je požadována po dokončení práce zahájené asynchronní žádostí.
Zpětná volání jsou požadována prostřednictvím HTTP POST volání a data jsou předávána v těle zakódovaná jako JSON. JSON objekt vždy obsahuje:
-
Informace o asynchronní žádosti (stejné jako při volání getAsyncRequest).
-
Podrobné informace o výsledku akce, jako je úplná analýza nebo podrobnosti o zakázce.
{ "asyncRequest": { ... } "analýza": { ... } }
Pokud není URL pro zpětné volání přístupná, žádost se opakuje po 2, 4, 8, 16 a 30 minutách, dokud neúspěšně neproběhne 10 pokusů.
URL pro zpětné volání musí odpovědět s HTTP stavovým kódem 200 OK, aby byla považována za úspěšnou.