Phrase TMS-API

API (TMS)

Inhalte werden von Phrase Language AI maschinell aus dem Englischen übersetzt.

Es stehen API-Aufrufe zur Verfügung, die Folgendes ermöglichen:

  • Integration von Phrase und Software von Drittanbietern (Übersetzungsmanagementtools, Content-Management-Systeme usw.)

  • Entwicklung einer Arbeitsumgebung für Übersetzer. Der CAT Editor basiert auf öffentlichen APIs.

  • Erstellung einer brandneuen Software oder Dienstleistung mit Phrase im Backend.

Developer Edition

Registrieren Sie sich für die Developer Edition, um APIs zu verwenden. Diese kostenlose Edition ist als Sandbox für die API-Entwicklung konzipiert. Benutzer können mit Postman APIs kennenlernen und testen.

Einschränkungen der Developer Edition:

Entwickler dürfen diese Edition ausschließlich zu Entwicklungs- und Testzwecken verwenden. Wende dich an den technischen Support, wenn du diese Limits erhöhen oder ändern musst.

  • Es sind jederzeit maximal 2 Übersetzungsaufträge gespeichert.

  • Maximal 1 MB für Jobdateigrößen.

  • Maximal 5 Administrator- oder Projektmanager-Benutzer und 1 Linguist pro Admin/PM.

Die API-Dokumentation ist auf einer dedizierten Website verfügbar. Sie wird automatisch generiert und kann heruntergeladen und exportiert werden.

Basic Workflow

Verfahren und Workflows müssen vor der Verwendung von APIs verstanden werden. Es wird empfohlen, vor der Implementierung des zugehörigen APIs mit einer Prozedur in Phrase vertraut zu sein.

Der grundlegende Arbeitsablauf ist:

  1. Erstellen Sie ein TM, TB und fügen Sie optional eine Engine für maschinelle Übersetzung hinzu.

  2. Erstellen Sie ein Projekt mit angebundener TM/TB/Engine für maschinelle Übersetzung (falls erforderlich).

  3. Lade deine Datei zur Übersetzung in das Projekt hoch (erstelle einen Job).

  4. Anschließend können Sie den Job analysieren, vorübersetzen oder einem Linguisten zuweisen.

Asynchronous APIs

Asynchrone APIs sollten immer ihren synchronen Pendants vorgezogen werden. Wenn Sie synchrone APIs aufrufen, besteht die Möglichkeit, dass bei der Verarbeitung großer Dateistapel oder sogar einer einzelnen großen Datei ein Timeout abgelaufen ist. Synchrone APIs sollten nur für kleine Dateien und kleine Integrationen verwendet werden.

Polling

Nach Aufruf einer asynchronen API wird eine Sofortantwort mit der Identifikatoranforderung empfangen. 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 eine asyncResponse empfangen wird, die nicht null ist.

Rückrufe

Als Reaktion auf die Nachteile des Polling-Ansatzes bei asynchronen Anfragen wird die Unterstützung für Callbacks in allen asynchronen APIs unterstützt. Geben Sie beim Aufruf einer asynchronen Anforderung eine URL (im CallbackUrl-Parameter) an, die angefordert wird, nachdem die durch die asynchrone Anforderung initiierte Arbeit abgeschlossen wurde.

Rückrufe werden über HTTP-POST-Aufrufe angefordert und die Daten werden im Body kodiert als JSON weitergegeben. Das JSON-Objekt enthält immer:

  • Informationen zur asynchronen Anforderung (genauso wie beim Aufruf von getAsyncRequest).

  • Detaillierte Informationen über das Ergebnis der Aktion wie eine vollständige Analyse oder Jobdetails.

{
   "asyncRequest": {
       ...
  }
 "analyse": {   
   ...
  }
}

Wenn eine Callback-URL nicht erreichbar ist, wird die Anforderung nach 2, 4, 8, 16 und 30 Minuten wiederholt, bis 10 Wiederholungen fehlgeschlagen sind.

Callback-URL muss mit dem HTTP-Statuscode 200 OK antworten, um als erfolgreich zu gelten.

War dieser Beitrag hilfreich?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.