K dispozici je sada volání API, která umožňují:
-
Integrace Phrase a softwaru třetích stran (Nástroje pro správu překladů, CMS atd.)
-
Vývoj překladatel pracovní plochy. CAT editor je postaven na veřejných API.
-
Vytvoření zbrusu nového nástroje nebo služby pomocí Phrase v jeho backendu.
Základní pracovní postup
Před použitím API je třeba porozumět postupům a pracovním postupům. Před implementací souvisejícího API doporučujeme seznámit se s procedurou ve Phrase.
Základní pracovní postup je:
-
Vytvořte TM, TB a volitelně přidejte nástroj strojového překladu.
-
Vytvořte projekt s připojeným nástrojem TM/TB/strojového překladu (v případě potřeby).
-
Uložit projekt jako šablonu projektu a znovu jej použít k vytvoření nového překladového projektu.
-
Nahrajte svůj soubor k překladu do projektu (vytvořit zakázku).
-
Zakázku pak můžete analyzovat, předpřeložit nebo přiřadit překladateli.
Asynchronní API
Asynchronní API by měla být vždy upřednostňována před svými synchronními protějšky. Při volání synchronních API existuje šance, že při zpracování velkých dávek souborů nebo dokonce jednoho velkého souboru obdrží odpovědi po vypršení časového limitu. Synchronní API by se měla používat pouze pro malé soubory a integraci v malém měřítku.
Volání
Po volání asynchronního API je přijata okamžitá odpověď včetně požadavku na identifikátor. Použijte tento identifikátor ke kontrole stavu požadavku zavoláním getAsyncRequest a zaškrtnutím pole asyncResponse. Tento přístup může vést k několika voláním getAsyncRequest před obdržením asyncResponse, která není nulová.
Návraty
Jako odpověď na nevýhody přístupu dotazování asynchronních požadavků je podporována podpora pro návraty ve všech asynchronních API. Při volání asynchronního požadavku zadejte URL (v parametru callbackUrl), která je požadována poté, co se Dokončí zakázka zahájená asynchronním požadavkem.
Volání jsou vyžadována voláním 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": {
...
}
„analýza“: {
...
}
}
Pokud návratová URL není přístupná, opakuje se požadavek po 2, 4, 8, 16 a 30 minutách, dokud se 10 opakování nezdaří.
Návratová URL musí odpovídat stavovým kódem 200 OK HTTP, aby byla považována za úspěšnou.