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.
Grundlegender Arbeitsablauf
Vorgehensweisen und Arbeitsabläufe müssen vor der Verwendung von APIs verstanden werden. Es wird empfohlen, sich vor der Implementierung der zugehörigen API mit einer Prozedur in phrase vertraut zu machen.
Der grundlegende Arbeitsablauf ist:
-
Ein TM, TB erstellen und optional eine maschinelle Übersetzung Engine hinzufügen.
-
Mit angehängter TM / TB / maschineller Übersetzung Engine (falls erforderlich) ein Projekt erstellen.
-
Das Projekt als Vorlage speichern und erneut verwenden, um ein neues Projekt für Übersetzungen zu erstellen.
-
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 Chance, dass abgelaufene Timeout-Antworten erhalten werden, wenn große Dateistapel oder sogar eine einzelne große Datei verarbeitet werden. Synchrone APIs sollten nur für kleine Dateien und kleine Integration verwendet werden.
Umfrage
Nach dem Aufruf einer asynchronen API wird eine sofortige Antwort mit der Identifikatoranforderung empfangen. Verwende diese Kennung, um den Status der Anfrage zu überprüfen, indem du getAsyncRequest aufrufst und das Feld asyncResponse überprüfst. Dieser Polling-Ansatz kann zu einer Anzahl von getAsyncRequest-Aufrufen führen, bevor eine asyncResponse empfangen wird, 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 callbackUrl-Parameter) an, die nach Abschließen des durch die asynchrone Anfrage initiierten Jobs angefordert wird.
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 (genauso 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 Callback-URL muss mit dem HTTP Status 200 OK antworten, um erfolgreich zu sein.