Dokumentasjon for oversettelses-API

Autentisering, en trygg første forespørsel og bestillingens livsløp, med eksempler i ren PHP. API v1 støtter tekst, dokumenter og lyd etter kontorettigheter.

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

Tilgang og autentisering

Kontakt oss for å avtale konto og rettigheter. Native kontoer bruker et utstedt Bearer-token. Denne versjonen har ikke et panel for selvbetjent oppretting av bedriftsnøkler. Kontakt oss

Authorization: Bearer YOUR_API_TOKEN

Lagre tokenet i en miljøvariabel eller beskyttet serverkonfigurasjon. Bruk HTTPS. Ikke legg tilgangsdata i URL-er, nettleser-JavaScript eller offentlige kodelagre.

En lagret passordhash er ikke et API-passord. SSO på nettstedet og API-autentisering er forskjellige mekanismer.

Første forespørsel

Start med å lese profilen din. Forespørselen oppretter ingen bestilling og belaster ikke saldoen.

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

Sett TRANSLATE24_API_TOKEN på serveren. Kontroller HTTP-status og JSON: et vellykket profilsvar inneholder et user-objekt.

Les de oppdaterte katalogene og bruk returnerte ID-er. Eksempel-ID-er er ikke nødvendigvis tilgjengelige for kontoen din.

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

Ren PHP

Dette skrivebeskyttede eksemplet bruker PHPs cURL-utvidelse uten rammeverk.

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'];

Behold profildata på serveren og vis bare feltene applikasjonen trenger. Eksemplet skriver ikke ut kundedata eller tilgangsdata.

Bestillingens livsløp

  1. Velg språkpar, type og tema fra katalogene. POST /order/create-as-draft oppretter en post uten automatisk å starte betalt arbeid.
  2. Kontroller errors, order, price og infoMessage i svaret. Enkelte dokumenter krever manuell ordtelling.
  3. POST /order/in-work?id=ORDER_ID&pay_by=1 kan belaste en saldo og starte arbeid. Innhent uttrykkelig godkjenning før kallet.
  4. Følg fremdriften med GET /order/view?id=ORDER_ID eller GET /order/index. Begrens hvor ofte du spør.

Felter for bestillingsutkast

Felter for bestillingsutkastBetydning
type1: tekst · 2: filer · 3: lyd
source_type1: tekstresultat · 2: lydresultat
language_pair_idID fra katalogen, eller from_language_code og to_language_code.
translate_type_idID for oversettelsestype fra katalogen
translate_theme_idTema-ID fra katalogen
source_textKildetekst for en tekstbestilling
uploadSourceFiles[]Multipart-opplasting av filer eller lyd
user_idValgfritt: en kunde opprettet av den autentiserte partneren. Ellers tilhører bestillingen den autentiserte kontoen.

Bruk skjemafelter for tekst og multipart/form-data for filer. La HTTP-klienten sette multipart-grensen.

For in-work bruker pay_by=1 saldoen til den autentiserte kontoen; pay_by=2 bruker bestillingseierens saldo og krever riktige partnerrettigheter og kundetilknytning.

Filer og lyd

Dokumenter: txt, odt, pdf, docx; opptil 5 filer på 5 MiB hver. Lyd: mp3, ogg, webm; opptil 5 filer på 15 MiB hver.

Kontroller hvert opplastingssvar. En bestillings-ID alene godkjenner ikke betalt arbeid hvis innlesing eller ordtelling mislykkes.

Feil og nye forsøk

401: kontroller autentisering. 403: kontroller rettigheter. 404: kontroller ID og eierskap. Et 2xx-svar med errors er en applikasjonsfeil; noen valideringsfeil bruker HTTP 200.

Etter tidsavbrudd eller 5xx kan en skriving allerede ha lykkes. Kontroller tilstanden før nytt forsøk. Ikke gjenta oppretting, betaling eller sletting automatisk: ingen kontrakt for idempotensnøkler er publisert. Lesekall kan gjentas et begrenset antall ganger med forsinkelse.

Eksterne kontoer

Eksterne kontoer bruker sin støttede Basic-autentisering og kan bare lese egen profil, oversettelseshistorikk og tillatte kataloger. De kan ikke opprette, starte eller slette bestillinger. Avtal en nativ integrasjons- eller partnerkonto for skrivetilgang.

Endepunktoversikt

Stiene er relative til basis-URL-en. Tilgang avhenger av kontorettigheter. Se Swagger for parameterskjemaer, eller kontakt oss for tilgang.

MetodeStiFormål
GET/user/viewDin profil
GET/user/listPartnerens kunder
POST/user/registrationOpprett partnerkunde
POST/user/deleteSlett partnerkunde
GET/order/indexTilgjengelige bestillinger
GET/order/viewBestillingsdetaljer
GET/order/get-data-for-create-orderBestillingsvalg
POST/order/create-as-draftOpprett utkast
POST/order/in-workGodkjenn betaling og start arbeid
POST/order/deleteSlett en bestilling som kan slettes
GET/languages/get-pairsSpråkpar
GET/languages/get-themesTemaer
GET/languages/get-typesOversettelsestyper

Swagger ↗ · Kontakt oss