Dokumentation

API-REFERENZ

Vereinfachen Sie Inhalte und übersetzen Sie sie in 24 Ausgabesprachen.

Der synchrone Endpunkt akzeptiert Quelltext, ein Ausgabesprache und einen von zwei Modi. Es erkennt die Quellsprache automatisch und liefert ein gebrauchsfertiges Ergebnis in der ausgewählten Ausgabesprache.

{
  "text": "Komplexer Ausgangstext in der ausgewählten Sprache.",
  "locale": "de",
  "mode": "simple-language"
}

SDK und cURL-Beispiele verfügbar

Endpunkt

POST /api/v2/translate

Erstellen Sie ein Einfache Sprache- oder Leichte Sprache-Ergebnis und geben Sie es in derselben HTTP-Antwort zurück.

Erforderliche Header

KopfbereichWertZweck
AuthorizationBearer <API_KEY>Authentifiziert das Projekt mit dem aktuellen HTTP-Bearer-Schema
Content-Typeapplication/jsonDeklariert das Format des Anforderungstexts
Acceptapplication/jsonFordert eine JSON-Antwort an
Idempotency-KeyNur für Jobs und Batches erforderlichVerhindert, dass wiederholte asynchrone Übermittlungen doppelte Arbeit verursachen

Anforderungstext

Keine andere Inhaltseinstellung ist Teil des öffentlichen Anforderungsschemas.

FeldTypErforderlichZulässiger WertBeschreibung
textZeichenfolgeJa1 bis 10.000 Unicode-ZeichenQuellinhalt im ausgewählten Sprachcode
localeZeichenfolgeJaEiner von 24 unterstützten Zwei-Buchstaben-CodesAusgabesprache. Die Ausgangssprache wird automatisch erkannt.
modeZeichenfolgeJaEinfache Sprache, Leichte SpracheVereinfachungsmodus
json
{
  "text": "Applicants must provide the required documentation before the deadline.",
  "locale": "en",
  "mode": "easy-language"
}

Antwortkörper

Die Antwort darf keine zurückgezogenen Anforderungseinstellungen oder ein separates Qualitätsinformationsarray enthalten.

FeldTypBeschreibung
requestIdZeichenfolgeEindeutige Kennung für Support und Protokolle
localeZeichenfolgeAusgewähltes Ausgabesprache
modeZeichenfolgeAusgewählter Vereinfachungsmodus
outputZeichenfolgeFertiges Ergebnis im ausgewählten Ausgabesprache
usage.inputCharactersganze ZahlFür diese Anfrage gezählte Zeichen oder 0 für einen Cache-Treffer
usage.cacheHitBoolescher WertOb das Ergebnis aus dem 30-Tage-Cache stammt
json
{
  "requestId": "req_sync_002",
  "locale": "en",
  "mode": "easy-language",
  "output": "You need to send documents.\nSend the documents before the deadline.",
  "usage": {
    "inputCharacters": 78,
    "cacheHit": false
  }
}

Validierungsverhalten

  • Fehlender Text: Mit einem dokumentierten Feldfehler ablehnen.
  • Leerer Text: Mit einem dokumentierten Feldfehler ablehnen.
  • Nicht unterstütztes Sprachcode: ablehnen; Ersetzen Sie niemals stillschweigend ein anderes Sprachcode.
  • Nicht unterstützter Modus: ablehnen; Wählen Sie niemals automatisch einen Modus aus.
  • Unbekanntes ausgemustertes Feld: Mit einem migrationsbezogenen Fehler ablehnen oder nur über eine explizit versionierte Kompatibilitätsschicht verarbeiten.
  • Der Quelltext verwendet möglicherweise eine andere Sprache als das Sprachcode. Simple8 erkennt die Quellsprache automatisch und schreibt das Ergebnis in das ausgewählte Ausgabesprache.