Es steht eine Reihe von API calls zur Verfügung, die Folgendes ermöglichen:
-
Integration von Phrase und beliebiger Software von Drittanbietern (Übersetzungsmanagement Tools, CMS usw.)
-
Entwicklung einer Arbeitsumgebung für Übersetzer. Der CAT Editor basiert auf öffentlichen APIs.
-
Erstellung eines brandneuen Tools oder einer Dienstleistung unter Verwendung von Phrase im Backend.
Grundlegender Workflow
Verfahren und Workflow müssen verstanden werden, bevor APIs verwendet werden. Es wird empfohlen, mit einem Verfahren in Phrase vertraut zu sein, bevor die zugehörige API implementiert wird.
Der grundlegende Workflow ist:
-
Erstellen Sie ein TM, TB und fügen Sie optional eine maschinelle Übersetzung Engine hinzu.
-
Erstellen Sie ein Projekt mit dem/der zugehörigen TM/TB/maschinellen Übersetzung Engine (falls erforderlich).
-
Speichern Sie das Projekt als Projekt Vorlage und verwenden Sie es wieder, um ein neues Übersetzungsprojekt zu erstellen.
-
Laden Sie Ihre Datei zur Übersetzung in das Projekt hoch (erstellen Sie einen Job).
-
Sie können den Job anschließend analysieren, vorübersetzen oder einem Linguist zuweisen.
Asynchrone APIs
Asynchrone APIs sollten ihren synchronen Gegenstücken immer vorgezogen werden. Beim Aufruf synchroner APIs besteht die Möglichkeit, dass bei der Verarbeitung großer Dateichargen oder sogar einer einzelnen großen Datei Antworten mit Zeitüberschreitung empfangen werden. Synchrone APIs sollten nur für kleine Dateien und Integrationen in kleinem Maßstab verwendet werden.
Polling
Nach dem Aufruf einer asynchronen API wird eine sofortige Antwort empfangen, die die Anforderungskennung enthält. Verwenden Sie diese Kennung, um den Status der Anfrage zu überprüfen, indem Sie getAsyncRequest aufrufen und das Feld asyncResponse prüfen. Dieser Polling-Ansatz kann zu einer Reihe von getAsyncRequest-Aufrufen führen, bevor eine asyncResponse empfangen wird, die nicht null ist.
Callbacks
Als Reaktion auf die Nachteile des Polling-Ansatzes für asynchrone Anfragen wird die Unterstützung für Callbacks in allen asynchronen APIs unterstützt. Geben Sie beim Aufrufen einer asynchronen Anfrage eine URL an (im Parameter callbackUrl), die aufgerufen wird, nachdem der durch die asynchrone Anfrage initiierte Job Abschließen ist.
Callbacks werden über HTTP POST-Aufrufe angefordert und die Daten werden im Body als JSON kodiert übergeben. Das JSON-Objekt enthält immer:
-
Informationen über die asynchrone Anfrage (dieselbe wie beim Aufruf von getAsyncRequest).
-
Detaillierte Informationen über das Ergebnis der Aktion, wie z. B. eine vollständige Analyse oder Job-Details.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
Wenn eine Callback-URL nicht erreichbar ist, wird die Anfrage nach 2, 4, 8, 16 und 30 Minuten wiederholt, bis 10 Wiederholungsversuche fehlgeschlagen sind.
Die Callback-URL muss mit dem HTTP-Statuscode 200 OK antworten, um als erfolgreich zu gelten.