Es ist eine Reihe von API Aufrufen verfügbar, die Folgendes ermöglichen:
-
Integration von Phrase und Drittanbietersoftware (Translation Management Tools, CMSs usw.)
-
Entwicklung einer Arbeitsumgebung für Übersetzer. Der CAT Editor basiert auf öffentlichen APIs.
-
Erstellung eines brandneuen Tools oder einer Dienstleistung mit Phrase im Backend.
Basic Workflow
Verfahren und Arbeitsabläufe müssen vor der Verwendung von APIs verstanden werden. Es wird empfohlen, sich vor der Implementierung der API mit einer Prozedur in phrase vertraut zu machen.
Der grundlegende Arbeitsablauf ist:
-
TM, TB erstellen und optional eine maschinelle Übersetzung Engine hinzufügen.
-
Projekt mit angehängter Engine für TM / TB / maschinelle Übersetzung erstellen (falls erforderlich).
-
Ihre Datei zur Übersetzung in das Projekt hochladen (Job erstellen).
-
Sie können den Job dann analysieren, vorübersetzen oder einem Linguisten zuweisen.
Asynchrone APIs
Asynchrone APIs sollten immer ihren synchronen Pendants vorgezogen werden. Beim Aufruf synchroner APIs besteht die Möglichkeit, dass bei der Verarbeitung großer Dateistapel oder sogar einer einzigen großen Datei eine abgelaufene Timeout-Antwort erhalten wird. Synchrone APIs sollten nur für kleine Dateien und kleine Integrationen verwendet werden.
Umfrage
Nach dem Aufruf einer asynchronen API erhältst du eine sofortige Antwort einschließlich der Identifikationsanforderung. Verwende diese Kennung, um den Status der Anfrage zu überprüfen, indem du getAsyncRequest aufrufst und das Feld asyncResponse aktivierst. Dieser Polling-Ansatz kann zu einer Anzahl von getAsyncRequest-Aufrufen führen, bevor Sie eine asyncResponse erhalten, die nicht null ist.
Callbacks
Als Reaktion auf die Nachteile des Polling-Ansatzes bei asynchronen Anfragen wird die Unterstützung für Callbacks in allen asynchronen APIs unterstützt. Gib beim Aufruf einer asynchronen Anfrage eine URL (im Parameter callbackUrl) an, die angefordert wird, nachdem der durch die asynchrone Anfrage initiierte Job Abgeschlossen ist.
Rückrufe werden über HTTP-POST-Aufrufe angefordert und die Daten werden in dem als JSON codierten Body weitergegeben. Das JSON-Objekt enthält immer:
-
Informationen zur asynchronen Anfrage (dasselbe wie beim Aufruf von getAsyncRequest).
-
Detaillierte Informationen über das Ergebnis der Aktion wie eine vollständige Analyse oder Job Details.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
Wenn eine Callback-URL nicht zugänglich ist, wird die Anfrage nach 2, 4, 8, 16 und 30 Minuten wiederholt, bis 10 Wiederholungen fehlgeschlagen sind.
Die Rückruf-URL muss mit dem HTTP Status 200 OK antworten, um als erfolgreich zu gelten.