Endpoint do wysyłania prośby o tłumaczenie
Ten endpoint umożliwia wysłanie prośby o tłumaczenie do systemu Ovesio. Możesz wysłać wiele tekstów w jednej prośbie, każdy z własnymi kluczami i kontekstami, a tłumaczenie może być wykonane jednocześnie w kilku językach.
Adres URL endpointu
https://api.ovesio.com/v1/translate/request
Metoda
POST
Format danych
application/json
Przykład prośby JSON
{
"from": "en",
"to": ["fr", "de"],
"conditions": {
"de": "fr"
},
"use_existing_translation": true,
"delta_mode": false,
"workflow": 1,
"callback_url": "https://example.com/api/callback",
"data": [
{
"ref": "product-123",
"content": [
{
"key": "title",
"value": "Gaming Laptop ASUS ROG"
},
{
"key": "description",
"value": "High-performance laptop for gaming",
"context": "Specificații produs"
}
]
}
]
}
Parametry aplikacji
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
| from | string | tak | Język źródłowy. Jeśli nie jest znany, można go pominąć ( AUTO). |
| delta_mode | Boolean | nie | Włącz callback tylko wtedy, gdy tłumaczenie różni się od poprzedniego. |
| Workflow | integer | nie | ID żądanego workflow. |
| use_existing_translation | Boolean | nie | Jeśli false, wymusza ponowne tłumaczenie, nawet jeśli tekst już istnieje w systemie. |
| to | Array | tak | Języki docelowe (np. ["fr", "de"]). |
| Conditions | Object | nie | Umożliwia definiowanie języków pośrednich w tłumaczeniach łańcuchowych (np. {"de": "fr"}). |
| callback_url | string | nie | Adres URL, na który wyniki tłumaczenia będą wysyłane za pomocą POST. |
| data | Array | tak | Teksty do przetłumaczenia. |
Struktura pola data
| Wymagany | Typ | Opis pola | |
|---|---|---|---|
| ref | string | nie | Unikalny identyfikator (np. ID produktu, przedmiot, itp.). |
| content | Array | tak | Lista tekstów, każdy z własnym value oraz opcjonalnym key i context. |
Struktura pola content
| Wymagany | Typ | Opis pola | |
|---|---|---|---|
| key | string | nie | Tag tekstowy (np. title, description itp.). |
| Value | string | tak | Aktualny tekst do przetłumaczenia. |
| context | string | nie | Kontekst semantyczny dla tłumaczenia (np. "kategoria produktu"). |
Możliwe odpowiedzi
Udana odpowiedź (HTTP 200)
{
"success": true,
"data": [
{
"id": 320126,
"ref": "product-123"
}
]
}
Potwierdzenie, że aplikacja została zaakceptowana i proces tłumaczenia został zainicjowany. Możesz użyć id, aby sprawdzić status później.
Odpowiedź o błędzie (HTTP 400 lub inny kod ≠ 200)
{
"success": false,
"errors": {
"invalid_data": "Invalid format detected"
}
}
Ta struktura wskazuje, że prośba była nieprawidłowa, a pole errors będzie zawierać szczegółowe informacje o napotkanym problemie.
Przykłady integracji
Możesz sprawdzić przykłady integracji dostępne na oficjalnej stronie GitHub Ovesio.
