Ein Satz von API-Aufrufen steht zur Verfügung, der Folgendes ermöglicht:
-
Integration von Phrase und jeder Drittanbieter-Software (Übersetzungsmanagement-Tools, CMS usw.)
-
Entwicklung einer Übersetzer-Arbeitsumgebung. Der CAT-Editor basiert auf öffentlichen APIs.
-
Erstellung eines brandneuen Tools oder Dienstes mit Phrase im Backend.
Grundlegender Arbeitsablauf
Verfahren und Arbeitsabläufe 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 Arbeitsablauf ist:
-
Erstellen Sie ein TM, TB und optional, fügen Sie eine maschinelle Übersetzungs-Engine hinzu.
-
Erstellen Sie ein Projekt mit dem TM/TB/der maschinellen Übersetzungs-Engine (falls erforderlich).
-
Speichern Sie das Projekt als Projektvorlage und verwenden Sie es erneut, um ein neues Übersetzungsprojekt zu erstellen.
-
Laden Sie Ihre Datei zur Übersetzung in das Projekt hoch (erstellen Sie einen Job).
-
Sie können dann analysieren, vorübersetzen oder den Job einem Linguisten zuweisen.
Asynchronous APIs
Asynchrone APIs sollten immer den synchronen Varianten vorgezogen werden. Wenn synchronen APIs aufgerufen werden, besteht die Möglichkeit, dass beim Verarbeiten großer Dateimengen oder sogar einer einzelnen großen Datei Zeitüberschreitungsantworten empfangen werden. Synchrone APIs sollten nur für kleine Dateien und kleine Integrationen verwendet werden.
Polling
Nach dem Aufruf einer asynchronen API wird eine sofortige Antwort einschließlich der Identifikationsanfrage empfangen. Verwenden Sie diesen Identifikator, um den Status der Anfrage zu überprüfen, indem Sie getAsyncRequest aufrufen und das asyncResponse Feld überprüfen. Dieser Polling-Ansatz kann zu einer Anzahl von getAsyncRequest Aufrufen führen, bevor eine asyncResponse empfangen wird, die nicht null ist.
Callbacks
Als Antwort auf die Nachteile des Polling-Ansatzes für asynchrone Anfragen wird die Unterstützung für Rückrufe in allen asynchronen APIs unterstützt. Beim Aufrufen einer asynchronen Anfrage geben Sie eine URL an (im callbackUrl Parameter), die angefordert wird, nachdem die Arbeit, die durch die asynchrone Anfrage initiiert wurde, abgeschlossen ist.
Rückrufe werden über HTTP POST-Anfragen angefordert und die Daten werden im Body als JSON kodiert übergeben. Das JSON-Objekt enthält immer:
-
Informationen über die asynchrone Anfrage (die gleichen wie beim Aufrufen von getAsyncRequest).
-
Detaillierte Informationen über das Ergebnis der Aktion, wie eine vollständige Analyse oder Jobdetails.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
Wenn eine Rückruf-URL nicht erreichbar ist, wird die Anfrage nach 2, 4, 8, 16 und 30 Minuten wiederholt, bis 10 Versuche fehlgeschlagen sind.
Die Rückruf-URL muss mit dem HTTP-Statuscode 200 OK antworten, um als erfolgreich angesehen zu werden.