API-referentie
Vereenvoudig en vertaal inhoud naar 24 uitvoertalen.
Het synchrone eindpunt accepteert brontekst, een uitvoerlandinstelling en een van de twee modi. Het detecteert de brontaal automatisch en retourneert een kant-en-klaar resultaat in de geselecteerde uitvoertaal.
{
"text": "Complexe broninhoud in de geselecteerde taal.",
"locale": "nl",
"mode": "simple-language"
}SDK- en cURL-voorbeelden beschikbaar
Eindpunt
POST /api/v2/translate
Maak één Plain Language- of Easy Language-resultaat en retourneer dit in hetzelfde HTTP-antwoord.
Verplicht hoofdstukken
| Inschrift | De waarde | Doel |
|---|---|---|
| Authorization | Bearer <API_KEY> | Authenticeert het project met het huidige HTTP Bearer-schema |
| Content-Type | aanvraag/json | Vermeld de vorm van het verzoek |
| Accept | aanvraag/json | Verzoek een JSON-reactie |
| Idempotency-Key | Alleen vereist voor taken en batches | Voorkomt dat herhaalde asynchrone inzendingen dubbel werk creëren |
Verzoekingsinstantie
Er is geen andere inhoudsinstelling die deel uitmaakt van het openbare verzoekschema.
| Veld | Type | Verplichting | Toegestane waarde | Beschrijving |
|---|---|---|---|---|
| text | stroom | - Ja, dat is het. | 1 tot 10.000 Unicode-tekens | Inhoud van de bron in de geselecteerde locatie |
| locale | stroom | - Ja, dat is het. | Een van de 24 ondersteunde tweeletterscodes | Uitvoertaal. De brontaal wordt automatisch gedetecteerd. |
| mode | stroom | - Ja, dat is het. | Eenvoudig, eenvoudig. | Eenvoudigingsmodus |
{
"text": "Applicants must provide the required documentation before the deadline.",
"locale": "en",
"mode": "easy-language"
}Reactie-organisme
Het antwoord mag geen ingetrokken verzoekinstellingen of een afzonderlijke matrix met kwaliteitsinformatie bevatten.
| Veld | Type | Beschrijving |
|---|---|---|
| requestId | stroom | Unieke identificatiecode voor ondersteuning en logs |
| locale | stroom | Geselecteerde uitvoerlandinstelling |
| mode | stroom | Selecteerde vereenvoudigingsmodus |
| output | stroom | Eindresultaat in de geselecteerde uitvoerlandinstelling |
| usage.inputCharacters | een geheel getal | Tekens geteld voor dit verzoek, of 0 voor een cachetreffer |
| usage.cacheHit | Booleaans | Of het resultaat afkomstig is van de 30-dagencache |
{
"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
}
}Valideringsgedrag
- Ontbrekende tekst: afwijzen met een gedocumenteerde veldfout.
- Leegtekst: verwerpen met een gedocumenteerde veldfout.
- Ondersteunde locale: verwerpen; nooit stilletjes vervangen door een andere locale.
- Niet ondersteunde modus: verwerpen; nooit automatisch een modus kiezen.
- Onbekend afgetrokken veld: verwerpen met een migratie-georiënteerde fout of behandelen alleen via een expliciet versie compatibiliteitslaag.
- De brontekst kan een andere taal gebruiken dan de landinstelling. Simple8 detecteert de brontaal automatisch en schrijft het resultaat in de geselecteerde uitvoerlandinstelling.