È disponibile una serie di chiamate API che consentono di:
-
Integrazione di phrase e qualsiasi software di terze parti (Strumenti gestionali della traduzione, CMS, ecc.)
-
Sviluppo di un workbench da traduttore. Il CAT editor è costruito sulle API pubbliche.
-
Creazione di un nuovissimo strumento o servizio utilizzando phrase nel suo backend.
Flusso di lavoro di base
Prima di utilizzare le API è necessario comprendere procedure e flusso di lavoro. È consigliabile conoscere una procedura in phrase prima di implementare l'API correlata.
Il flusso di lavoro di base è:
-
Creare una TM, TB e, facoltativamente, aggiungere un motore di traduzione automatica.
-
Creare un progetto con il motore TM/TB/traduzione automatica collegato (se necessario).
-
Salvare il progetto come modello di progetto e riutilizzarlo per creare un nuovo progetto di traduzione.
-
Carica il tuo file da tradurre nel progetto (crea un lavoro).
-
Puoi quindi analizzare, pre-tradurre o assegnare il lavoro a un traduttore.
API asincrone
Le API asincrone dovrebbero sempre essere preferite alle loro controparti sincrone. Se si chiamano API sincrone, è possibile ricevere risposte scadute durante l'elaborazione di grandi lotti di file o anche di un solo file di grandi dimensioni. Le API sincrone devono essere utilizzate solo per file di piccole dimensioni e integrazione su piccola scala.
Sondaggio
Dopo aver chiamato un'API asincrona, viene ricevuta una risposta immediata inclusa la richiesta di identificatore. Usare questo identificatore per controllare lo stato della richiesta chiamando getAsyncRequest e controllando il campo asyncResponse. Questo approccio di polling può comportare diverse chiamate getAsyncRequest prima di ricevere un asincronoRisposta che non è nullo.
Chiamate
In risposta agli inconvenienti dell'approccio del polling alle richieste asincrone, è supportato il supporto per i callback in tutte le API asincrone. Quando si chiama una richiesta asincrona, specificare un URL (nel parametro callbackUrl) che viene richiesto al termine del lavoro avviato dalla richiesta asincrona.
Le richiamate vengono richieste tramite chiamate HTTP POST e i dati vengono trasmessi nel corpo codificato come JSON. L'oggetto JSON contiene sempre:
-
Informazioni sulla richiesta asincrona (la stessa utilizzata quando si chiama getAsyncRequest).
-
Informazioni dettagliate sul risultato dell'azione come un'analisi completa o dettagli del lavoro.
{
"asyncRequest": {
...
}
"analisi": {
...
}
}
Se un URL di richiamata non è accessibile, la richiesta viene ripetuta dopo 2, 4, 8, 16 e 30 minuti finché 10 tentativi non sono andati a buon fine.
L'URL di richiamata deve rispondere con il codice di stato HTTP 200 OK per essere considerato corretto.