Dokumentation för översättnings-API

Autentisering, en säker första förfrågan och beställningens livscykel, med exempel i ren PHP. API v1 stöder text, dokument och ljud enligt kontots behörigheter.

Bas-URLhttps://api.translate24.pro/v1

Åtkomst och autentisering

Kontakta oss för att komma överens om konto och behörigheter. Inbyggda konton använder en utfärdad Bearer-token. Den här versionen saknar en panel för att själv skapa företagsnycklar. Kontakta oss

Authorization: Bearer YOUR_API_TOKEN

Lagra token i en miljövariabel eller skyddad serverkonfiguration. Använd HTTPS. Lägg aldrig autentiseringsuppgifter i URL:er, JavaScript i webbläsaren eller offentliga kodarkiv.

En lagrad lösenordshash är inte ett API-lösenord. Webbplatsens SSO och API-autentisering är separata mekanismer.

Första förfrågan

Börja med att läsa din profil. Förfrågan skapar ingen beställning och drar inget från saldot.

cURL
curl --request GET \
  'https://api.translate24.pro/v1/user/view' \
  --header "Authorization: Bearer $TRANSLATE24_API_TOKEN" \
  --header 'Accept: application/json'

Ställ in TRANSLATE24_API_TOKEN på servern. Kontrollera HTTP-status och JSON: ett lyckat profilsvar innehåller ett user-objekt.

Läs aktuella kataloger och använd de returnerade identifierarna. Exempel-ID:n kanske inte är tillgängliga för ditt konto.

  • GET /languages/get-pairs
  • GET /languages/get-themes
  • GET /languages/get-types
  • GET /order/get-data-for-create-order

Ren PHP

Det här skrivskyddade exemplet använder PHP:s cURL-tillägg utan ramverk.

PHP
<?php
$token = getenv('TRANSLATE24_API_TOKEN');
if (!is_string($token) || $token === '') {
    throw new RuntimeException('API token is not configured.');
}

$ch = curl_init('https://api.translate24.pro/v1/user/view');
if ($ch === false) {
    throw new RuntimeException('Unable to initialize cURL.');
}
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_CONNECTTIMEOUT => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
        'Accept: application/json',
    ],
]);
$body = curl_exec($ch);
$httpStatus = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($body === false) {
    // Keep diagnostic details in a protected server log.
    throw new RuntimeException('API connection failed.');
}
$data = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
if ($httpStatus < 200 || $httpStatus >= 300) {
    throw new RuntimeException('API HTTP error: ' . $httpStatus);
}
if (!is_array($data) || isset($data['errors'])
    || !isset($data['user']) || !is_array($data['user'])) {
    throw new RuntimeException('Unexpected API response.');
}
$user = $data['user'];

Behåll profildata på servern och visa bara nödvändiga fält. Exemplet skriver inte ut kunddata eller autentiseringsuppgifter.

Beställningens livscykel

  1. Välj språkpar, typ och ämne ur katalogerna. POST /order/create-as-draft skapar en post utan att automatiskt starta betalt arbete.
  2. Kontrollera errors, order, price och infoMessage i svaret. Vissa dokument kräver manuell ordräkning.
  3. POST /order/in-work?id=ORDER_ID&pay_by=1 kan debitera ett saldo och starta arbete. Inhämta uttryckligt godkännande före anropet.
  4. Följ arbetet med GET /order/view?id=ORDER_ID eller GET /order/index. Begränsa frågefrekvensen.

Fält för beställningsutkast

Fält för beställningsutkastBetydelse
type1: text · 2: filer · 3: ljud
source_type1: textresultat · 2: ljudresultat
language_pair_idID från katalogen, eller from_language_code och to_language_code.
translate_type_idID för översättningstyp från katalogen
translate_theme_idÄmnes-ID från katalogen
source_textKälltext för en textbeställning
uploadSourceFiles[]Multipart-uppladdning av filer eller ljud
user_idValfritt: en kund skapad av den autentiserade partnern. Annars tillhör beställningen det autentiserade kontot.

Använd formulärfält för text och multipart/form-data för filer. Låt HTTP-klienten ange multipart-gränsen.

För in-work använder pay_by=1 det autentiserade kontots saldo; pay_by=2 beställningsägarens saldo och kräver rätt partnerbehörighet och kundkoppling.

Filer och ljud

Dokument: txt, odt, pdf, docx; högst 5 filer på 5 MiB vardera. Ljud: mp3, ogg, webm; högst 5 filer på 15 MiB vardera.

Kontrollera varje uppladdningssvar. Ett beställnings-ID ensamt godkänner inte betalt arbete om tolkning eller ordräkning misslyckas.

Fel och nya försök

401: kontrollera autentisering. 403: kontrollera behörigheter. 404: kontrollera ID och ägarskap. Ett 2xx-svar med errors är ett applikationsfel; vissa valideringsfel använder HTTP 200.

Efter timeout eller 5xx kan skrivningen redan ha lyckats. Kontrollera tillståndet innan du försöker igen. Upprepa inte skapande, betalning eller radering automatiskt: inget avtal för idempotensnycklar är publicerat. Läsanrop kan upprepas ett begränsat antal gånger med väntetid.

Externa konton

Externa konton använder sin stödda Basic-autentisering och får bara läsa egen profil, översättningshistorik och tillåtna kataloger. De får inte skapa, skicka till arbete eller radera beställningar. Ordna ett inbyggt integrations- eller partnerkonto för skrivåtkomst.

Endpointreferens

Sökvägarna är relativa till bas-URL:en. Åtkomst beror på kontots behörigheter. Se Swagger för parameterscheman eller kontakta oss för åtkomst.

MetodSökvägSyfte
GET/user/viewDin profil
GET/user/listPartnerns kunder
POST/user/registrationSkapa partnerkund
POST/user/deleteRadera partnerkund
GET/order/indexTillgängliga beställningar
GET/order/viewBeställningsdetaljer
GET/order/get-data-for-create-orderBeställningsalternativ
POST/order/create-as-draftSkapa utkast
POST/order/in-workGodkänn betalning och starta arbete
POST/order/deleteRadera tillåten beställning
GET/languages/get-pairsSpråkpar
GET/languages/get-themesÄmnen
GET/languages/get-typesÖversättningstyper

Swagger ↗ · Kontakta oss