API

Übersetze JSON und Dateien, verfolge den Fortschritt und lade fertige Übersetzungen von deinem Server aus herunter.

Nutze die Lingo.dev API, um Inhalte zu übersetzen, die deine Anwendung verwaltet. Ein Lokalisierungsauftrag umfasst eine Engine, eine Ausgangssprache, Zielsprachen und ein oder mehrere Dokumente. Für jedes Dokument wird pro angeforderter Sprache ein Übersetzungsziel nachverfolgt. Bei den meisten Formaten entstehen separate Zieldateien; Apple String Catalogs bündeln mehrere Sprachen in einer Datei.

Die Basis-URL der API lautet https://api.lingo.dev/v2. Bewahre deine API-Zugangsdaten auf deinem Server auf. Starte mit deiner ersten Übersetzungsanfrage, um zwei Nachrichten zu übersetzen und das Ergebnis zu speichern.

Eingabe wählen #

Deine InhalteHier starten
Ein JSON-Objekt, das deiner Anwendung bereits vorliegtJSON übersetzen. Sende das Objekt direkt mit der Anfrage zum Erstellen des Auftrags.
Dateien wie JSON, Markdown, HTML oder Ressourcen für mobile AppsDokumente übersetzen. Lade die unveränderten Dateibytes hoch und die übersetzten Dateien im selben Format herunter.
Mehrere Dokumente oder ZielsprachenEinen Übersetzungsauftrag erstellen. Ein Auftrag kann sowohl direkt eingebettetes JSON als auch hochgeladene Dateien enthalten.

Alle drei Varianten folgen demselben Ablauf:

  1. Erstelle einen Auftrag und speichere seine ID zusammen mit der Version der Ausgangsinhalte.
  2. Lade jedes Artefakt hoch, das im Array uploads der Antwort aufgeführt ist. Direkt eingebettete JSON-Ausgangsinhalte werden beim Erstellen gespeichert.
  3. Starte den Auftrag.
  4. Rufe den Fortschritt des Auftrags ab, bis die benötigten Übersetzungsziele der Dokumente fertiggestellt sind.
  5. Lade jedes fertiggestellte Übersetzungsziel über dessen status.downloadUrl herunter.

Beim Erstellen werden die anstehenden Aufgaben gespeichert. Erst beim Starten werden sie zur Verarbeitung zugelassen und die Verarbeitung beginnt. Eine erfolgreiche Antwort auf die Erstellungsanfrage ist noch kein Übersetzungsergebnis.

Schätze den Aufwand ab, bevor du einen Auftrag erstellst, wenn du die Wiederverwendung und die ungefähren Kosten einsehen möchtest.

Übersetzung konfigurieren #

Wähle die Engine explizit über engineId aus. Sie stellt Modelle, Glossare, Regeln und die Markenstimme sowie die Übersetzungspipeline bereit. Der API-Schlüssel muss zum Übersetzen mit dieser Engine berechtigt sein.

Füge für JSON über format.options dokumentbezogenen Kontext, Hinweise und geschützte Pfade hinzu. Gib für eine spätere Version die vorherigen Ausgangsinhalte und Übersetzungen an, um unveränderte Inhalte wiederzuverwenden.

Mit der menschlichen Prüfung können autorisierte Prüfer dafür vorgesehene Übersetzungen freigeben oder bearbeiten, bevor die Pipeline fortgesetzt wird. Der Leitfaden zum Prüfungs-Workflow erklärt, wie du Einreichung, Prüfung und Auslieferung miteinander verbindest.

Anwendungszustand zusammen mit dem Auftrag speichern #

Speichere die Auftrags-ID, die Version der Ausgangsinhalte, die Dokumentschlüssel und die angeforderten Sprachen dauerhaft, bevor du fortfährst. Verwende beim Erstellen eines Auftrags den Header Idempotency-Key, damit du die Anfrage bei einer unklaren Antwort wiederholen kannst, ohne einen weiteren Auftrag zu erstellen. Rufe bestehende Aufträge ab, bevor du einen Ersatz einreichst.

Lade fertiggestellte Übersetzungsziele auch dann herunter, wenn ein anderes Übersetzungsziel fehlschlägt. Veröffentliche ein Ergebnis nur, wenn es noch zu der Version der Ausgangsinhalte gehört, die deine Anwendung erwartet. Einen Übersetzungs-Workflow erstellen erläutert, wie du diese Schritte koordinierst.

Informationen zu Zugriff und Fehlerbehebung findest du unter Authentifizierung, Fehler und im Fehlerkatalog.

Eine Engine vorbereiten und verbessern #

Die Bereitstellung befüllt Glossare, Regeln und die Markenstimme anhand von Website-Inhalten oder Text. Engine-Vorschläge machen aus Feedback Vorschläge, die du ansehen und anwenden kannst. Führe eine Prüfung der generierten Vorgaben durch, bevor du dich bei der Übersetzung darauf verlässt.