Consulter une tâche de traduction
Examinez les cibles des documents, attendez la fin du traitement et téléchargez les résultats disponibles.
Consultez une tâche à l’aide de id renvoyé lors de la création :
GET /v2/localization/jobs/:id
X-API-Key: YOUR_API_KEYLa réponse décrit tous les documents et leurs langues cibles. Certaines cibles peuvent être terminées alors que d’autres sont encore en cours de traitement ou ont échoué.
Champs de la tâche #
| Champ | Signification |
|---|---|
id, organizationId, engineId | Identité de la tâche, organisation propriétaire et moteur. |
sourceLocale | Langue source. |
trigger | Origine, par exemple api, cli, ci ou une intégration. |
status | État de la tâche identifié par une étiquette, décrit ci-dessous. |
createdAt, updatedAt | Horodatages au format ISO, sous forme de chaînes de caractères. |
createdBy | Informations sur la personne ayant créé la tâche, ou null si elles ne sont pas disponibles. Une clé personnelle est attribuée à la personne qui l’utilise. |
documents | Documents, leurs formats et adresses sources, et progression des cibles. |
uploads | Adresses des artefacts manquants et URL de téléversement tant que la tâche est en attente ; vide une fois la tâche démarrée. |
États de la tâche #
status._tag | Action à effectuer |
|---|---|
Pending | Téléversez les artefacts manquants et appelez /start. |
Running | Interrogez à nouveau la tâche plus tard ; examinez les étapes des cibles pour vérifier si le traitement est en cours ou en attente de relecture. |
Completed | Téléchargez et examinez les résultats. Vérifiez les avertissements des étapes avant d’accepter les résultats. |
Failed | Consultez status.message et les échecs des cibles. Les cibles terminées restent disponibles. |
Cancelled | Le traitement s’est arrêté. Examinez les cibles pour repérer les éventuels résultats déjà terminés. |
Completed, Failed et Cancelled sont des états finaux de la tâche. Un échec partiel désigne une tâche en échec comportant à la fois des cibles terminées et des cibles en échec.
Champs des documents et des cibles #
Chaque document contient id, key, format, source, previousSource et targets. source est une adresse d’artefact, même lorsque la requête fournit directement du JSON. previousSource vaut null en cas d’absence.
Chaque cible contient :
| Champ | Signification |
|---|---|
locale | Langue cible. |
previousTranslation | Adresse de l’artefact cible précédent, ou null. |
status | Pending, Completed ou Failed dans son champ _tag. |
stages | Progression des étapes, avec leur statut et le nombre d’unités. |
Le statut d’une cible terminée contient artifact et downloadUrl ; celui d’une cible en échec contient message. Cet extrait de réponse présente le statut d’une cible terminée :
{
"_tag": "Completed",
"artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}Utilisez l’adresse et l’URL effectivement renvoyées. L’URL est relative à https://api.lingo.dev et nécessite une authentification ; ce n’est pas un lien de téléchargement public signé. Le téléchargement renvoie les octets du fichier dans le format du document.
Plusieurs cibles peuvent partager un même artefact. Un catalogue de chaînes Apple regroupe les langues demandées dans un seul fichier .xcstrings ; enregistrez ce résultat combiné une seule fois et examinez ses entrées par langue, plutôt que de traiter chaque téléchargement comme un catalogue distinct contenant une seule langue.
Interroger et récupérer #
Interrogez la tâche à intervalles définis, par exemple toutes les deux secondes, en fixant un délai maximal côté application. Si une lecture échoue temporairement, conservez l’ID et réessayez en espaçant progressivement les tentatives. Mettre fin à l’attente n’annule pas le traitement côté serveur. La relecture humaine peut prendre bien plus de temps que le court délai d’expiration d’une requête applicative.
Téléchargez une cible dès que son statut est Completed. Si votre application exige que toutes les langues soient publiées ensemble, attendez que toutes les cibles requises soient terminées et appliquez cette règle de publication dans votre propre stockage. La disponibilité d’un seul fichier terminé ne garantit pas que toutes les langues ont été traitées avec succès.
Pour un programme complet d’interrogation périodique et de téléchargement, utilisez le guide de démarrage rapide. Pour gérer les révisions des sources et décider quand réessayer, consultez créer un workflow de traduction.