Einen Übersetzungsauftrag abrufen

Dokumentziele ansehen, auf den Abschluss warten und verfügbare Ausgaben herunterladen.

Rufe einen Auftrag mit der id ab, die bei der Erstellung zurückgegeben wurde:

http
GET /v2/localization/jobs/:id
X-API-Key: YOUR_API_KEY

Die Antwort beschreibt alle Dokumente und ihre Zielsprachen. Sie kann bereits abgeschlossene Ziele enthalten, während andere noch verarbeitet werden oder fehlgeschlagen sind.

Auftragsfelder #

FeldBedeutung
id, organizationId, engineIdAuftragskennung, Organisation, der der Auftrag gehört, und Engine.
sourceLocaleAusgangssprache.
triggerHerkunft, etwa api, cli, ci oder eine Integration.
statusAuftragszustand mit Typkennzeichnung, wie unten beschrieben.
createdAt, updatedAtISO-Zeitstempel als Zeichenfolgen.
createdByAngaben zur Person, die den Auftrag erstellt hat, oder null, wenn diese nicht verfügbar sind. Ein persönlicher Schlüssel wird der Person zugeordnet, die ihn verwendet.
documentsDokumente, ihre Formate und Quelladressen sowie der Verarbeitungsfortschritt der Ziele.
uploadsAdressen fehlender Artefakte und Upload-URLs, solange der Auftrag aussteht; nach dem Start des Auftrags leer.

Auftragszustände #

status._tagNächste Schritte
PendingLade fehlende Artefakte hoch und rufe /start auf.
RunningFrage den Status später erneut ab. Sieh dir die Zielphasen an, um festzustellen, ob die Verarbeitung läuft oder auf eine Prüfung gewartet wird.
CompletedLade die Ausgaben herunter und sieh sie dir an. Beachte bei der Abnahme auch die Warnungen der einzelnen Phasen.
FailedLies status.message und die Fehlermeldungen der Ziele. Abgeschlossene Ziele bleiben verfügbar.
CancelledDie Verarbeitung wurde gestoppt. Sieh dir die Ziele an, um bereits fertiggestellte Ausgaben zu finden.

Completed, Failed und Cancelled sind endgültige Auftragszustände. Bei einem teilweisen Fehlschlag gilt der Auftrag als fehlgeschlagen, obwohl einige Ziele abgeschlossen sind und andere fehlgeschlagen sind.

Dokument- und Zielfelder #

Jedes Dokument enthält id, key, format, source, previousSource und targets. source ist auch dann eine Artefaktadresse, wenn die Anfrage Inline-JSON übermittelt hat. Ist previousSource nicht vorhanden, lautet der Wert null.

Jedes Ziel enthält:

FeldBedeutung
localeZielsprache.
previousTranslationAdresse des vorherigen Zielartefakts oder null.
statusPending, Completed oder Failed im Feld _tag.
stagesPhasenfortschritt, einschließlich Status und Anzahl der Einheiten.

Der Status eines abgeschlossenen Ziels enthält artifact und downloadUrl; der Status eines fehlgeschlagenen Ziels enthält message. Dieser Auszug aus der Antwort zeigt den Status eines abgeschlossenen Ziels:

json
{
  "_tag": "Completed",
  "artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Verwende die tatsächlich zurückgegebene Adresse und URL. Die URL ist relativ zu https://api.lingo.dev und erfordert eine Authentifizierung; sie ist kein öffentlich zugänglicher, signierter Download-Link. Der Download liefert die Bytes der Datei im Format des Dokuments.

Mehrere Ziele können sich ein Artefakt teilen. Ein Apple String Catalog fasst die angeforderten Sprachen in einer .xcstrings-Datei zusammen. Speichere diese gemeinsame Ausgabe einmal und sieh dir die Einträge für die einzelnen Sprachen an, statt jeden Download als separaten einsprachigen Katalog zu behandeln.

Status abfragen und Ausgaben sammeln #

Frage den Auftragsstatus in einem festgelegten Intervall ab, etwa alle zwei Sekunden, und lege eine Zeitgrenze für die Anwendung fest. Falls ein Abruf vorübergehend fehlschlägt, behalte die ID bei und wiederhole den Versuch mit zunehmenden Wartezeiten. Wenn du das Warten beendest, läuft die Verarbeitung auf dem Server weiter. Eine Prüfung durch Menschen kann erheblich länger dauern als das kurze Zeitlimit einer Anwendungsanfrage.

Lade ein Ziel herunter, sobald sein Status Completed ist. Wenn deine Anwendung alle Sprachen gemeinsam veröffentlichen muss, warte auf alle erforderlichen Ziele und setze diese Veröffentlichungsregel in deinem eigenen Speicher um. Eine einzelne fertiggestellte Datei belegt nicht, dass die Verarbeitung für jede Sprache erfolgreich war.

Ein vollständiges Programm für Statusabfragen und Downloads findest du im Schnellstart. Informationen zum Umgang mit Quellrevisionen und zur Entscheidung, wann ein erneuter Versuch sinnvoll ist, findest du unter Einen Übersetzungsworkflow erstellen.