Je k dispozici sada API volání, která umožňuje:
-
Integrace Phrase a jakéhokoli softwaru třetích stran (Nástroje pro řízení překladů, CMS atd.)
-
Vývoj překladatelského prostředí pro překladatel. CAT Editor je postaven na veřejných API.
-
Vytvoření zcela nového nástroje nebo služba využívající Phrase ve svém backendu.
Základní pracovní postup
Před použitím API je nutné porozumět postupům a pracovní postup. Před implementací souvisejícího API se doporučuje seznámit se s postupem v Phrase.
Základní pracovní postup je:
-
Vytvořit TM, TB a volitelně přidat strojový překlad nástroj.
-
Vytvořit projekt s připojeným TM/TB/strojový překlad nástroj (v případě potřeby).
-
Uložit projekt jako šablona a znovu ji použít k vytvoření nového překladového projektu.
-
Nahrát soubor k překladu do projektu (vytvořit zakázka).
-
Poté můžete analyzovat, Předpřeložit nebo přiřadit zakázka překladatel.
Asynchronní API
Asynchronní API by měla být vždy upřednostňována před jejich synchronními protějšky. Při volání synchronních API existuje riziko obdržení odpovědí o vypršení časového limitu při zpracování velkých dávek souborů nebo dokonce jednoho velkého souboru. Synchronní API by měla být používána pouze pro malé soubory a integrace malého rozsahu.
Dotazování
Po zavolání asynchronního API je přijata okamžitá odpověď obsahující identifikátor požadavku. Použijte tento identifikátor ke kontrole stavu požadavku zavoláním getAsyncRequest a kontrolou pole asyncResponse. Tento přístup dotazování může vést k řadě volání getAsyncRequest před přijetím asyncResponse, které není null.
Zpětná volání
Jako reakce na nevýhody přístupu dotazování u asynchronních požadavků je podporována podpora zpětných volání ve všech asynchronních API. Při volání asynchronního požadavku zadejte URL (v parametru callbackUrl), která je vyžádána poté, co je zakázka iniciovaná asynchronním požadavkem Dokončit.
Zpětná volání jsou vyžadována prostřednictvím volání HTTP POST a data jsou předávána v těle zakódovaném jako JSON. Objekt JSON vždy obsahuje:
-
Informace o asynchronním požadavku (stejné jako při volání getAsyncRequest).
-
Podrobné informace o výsledku akce, jako je úplná analýza nebo podrobnosti o zakázce.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
Pokud není URL zpětného volání přístupná, požadavek se opakuje po 2, 4, 8, 16 a 30 minutách, dokud 10 pokusů neselže.
URL zpětného volání musí odpovědět stavovým kódem HTTP 200 OK, aby byla považována za úspěšnou.