Un ensemble d'appels API est disponible, ce qui permet :
-
L'intégration de Phrase et de tout logiciel tiers (outils de gestion de traduction, CMS, etc.)
-
Développement d’un environnement de travail pour traducteurs. Le CAT Editor est construit sur des API publiques.
-
Création d'un tout nouvel outil ou service utilisant Phrase dans son backend.
Flux de travaux de base
Les procédures et le flux de travaux doivent être compris avant d'utiliser les API. Il est recommandé d'être familiarisé avec une procédure dans Phrase avant de mettre en œuvre l'API associée.
Le flux de travaux de base est :
-
Créer un MT, BT et, en option, ajouter un moteur de traduction automatique.
-
Créer un projet avec le MT/BT/moteur de traduction automatique attaché (si nécessaire).
-
Enregistrer le projet en tant que modèle de projet et le réutiliser pour créer un nouveau projet de traduction.
-
Charger votre fichier pour la traduction dans le projet (créer une tâche).
-
Vous pouvez ensuite analyser, pré-traduire ou assigner la tâche à un linguiste.
APIs asynchrones
Les API asynchrones doivent toujours être préférées à leurs homologues synchrones. Si vous appelez des API synchrones, il existe un risque de recevoir des réponses indiquant un délai d’attente expiré lors du traitement de grands lots de fichiers ou même d’un seul fichier volumineux. Les API synchrones ne doivent être utilisées que pour de petits fichiers et une intégration à petite échelle.
Sondage
Après avoir appelé une API asynchrone, une réponse instantanée est reçue, y compris l'identifiant de la demande. Utilisez cet identifiant pour vérifier le statut de la demande en appelant getAsyncRequest et en vérifiant le champ asyncResponse. Cette approche de sondage peut entraîner un certain nombre d'appels getAsyncRequest avant de recevoir une asyncResponse qui n'est pas nulle.
Callbacks
En réponse aux inconvénients de l'approche de sondage pour les demandes asynchrones, le support des callbacks dans toutes les API asynchrones est pris en charge. Lors de l'appel d'une demande asynchrone, spécifiez une URL (dans le paramètre callbackUrl) qui est demandée après que le travail initié par la demande asynchrone soit terminé.
Les callbacks sont demandés via des appels HTTP POST et les données sont transmises dans le corps encodé en JSON. L'objet JSON contient toujours :
-
Des informations sur la demande asynchrone (les mêmes que lors de l'appel getAsyncRequest).
-
Des informations détaillées sur le résultat de l'action, telles qu'une analyse complète ou des détails de la tâche.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
Si une URL de callback n'est pas accessible, la requête est répétée après 2, 4, 8, 16 et 30 minutes, jusqu'à ce que 10 tentatives aient échoué.
L'URL de callback doit répondre avec le code de statut HTTP 200 OK pour être considérée comme réussie.