Consultar un trabajo de traducción
Revisa los destinos de los documentos, espera a que se completen y descarga los resultados disponibles.
Consulta un trabajo con el id que se devuelve al crearlo:
GET /v2/localization/jobs/:id
X-API-Key: YOUR_API_KEYLa respuesta describe todos los documentos y sus idiomas de destino. Puede incluir destinos completados mientras otros siguen en ejecución o han fallado.
Campos del trabajo #
| Campo | Significado |
|---|---|
id, organizationId, engineId | Identidad del trabajo, organización propietaria y motor. |
sourceLocale | Idioma de origen. |
trigger | Origen, como api, cli, ci o una integración. |
status | Estado del trabajo con una etiqueta, descrito a continuación. |
createdAt, updatedAt | Marcas de tiempo en formato ISO, expresadas como cadenas. |
createdBy | Información de quien creó el trabajo, o null si no está disponible. Una clave personal se atribuye a su usuario. |
documents | Documentos, sus formatos y direcciones de origen, y el progreso de los destinos. |
uploads | Direcciones de los artefactos faltantes y URL de carga mientras el trabajo está pendiente; el campo queda vacío una vez que el trabajo comienza. |
Estados del trabajo #
status._tag | Qué hacer |
|---|---|
Pending | Carga los artefactos faltantes y llama a /start. |
Running | Vuelve a consultar más tarde; revisa las etapas de los destinos para ver si hay trabajo en curso o si están a la espera de una revisión. |
Completed | Descarga y revisa los resultados. Verifica las advertencias de las etapas como parte del proceso de aceptación. |
Failed | Consulta status.message y los errores de los destinos. Los destinos completados siguen disponibles. |
Cancelled | El trabajo se detuvo. Revisa los destinos para ver si hay resultados ya completados. |
Completed, Failed y Cancelled son estados finales del trabajo. Un error parcial corresponde a un trabajo fallido con una combinación de destinos completados y fallidos.
Campos de documentos y destinos #
Cada documento contiene id, key, format, source, previousSource y targets. source es una dirección de artefacto incluso si la solicitud incluyó JSON en línea. previousSource tiene el valor null cuando no está presente.
Cada destino contiene:
| Campo | Significado |
|---|---|
locale | Idioma de destino. |
previousTranslation | Dirección del artefacto de destino anterior, o null. |
status | Pending, Completed o Failed en su campo _tag. |
stages | Progreso de las etapas, incluidos el estado y los conteos de unidades. |
El estado de un destino completado contiene artifact y downloadUrl; el de un destino fallido contiene message. Este fragmento de la respuesta muestra el estado de un destino completado:
{
"_tag": "Completed",
"artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}Usa la dirección y la URL que se devuelven en la respuesta. La URL es relativa a https://api.lingo.dev y requiere autenticación; no es un enlace de descarga firmado de acceso público. La descarga devuelve los bytes del archivo en el formato del documento.
Varios destinos pueden compartir un artefacto. Un catálogo de cadenas de Apple combina los idiomas solicitados en un solo archivo .xcstrings; guarda ese resultado combinado una sola vez y revisa sus entradas de idioma, en lugar de tratar cada descarga como un catálogo independiente de un solo idioma.
Consultar periódicamente y recopilar #
Consulta el trabajo a intervalos controlados, por ejemplo, cada dos segundos, y establece un tiempo límite en la aplicación. Si una consulta falla temporalmente, conserva el ID y vuelve a intentarlo con intervalos de espera crecientes. Dejar de esperar no cancela el procesamiento en el servidor. La revisión humana puede tardar mucho más que el breve tiempo de espera de una solicitud de la aplicación.
Descarga un destino cuando su estado sea Completed. Si tu aplicación necesita publicar todos los idiomas juntos, espera a que se completen todos los destinos requeridos y aplica esa regla de publicación en tu propio almacenamiento. Que un archivo esté completado no significa que todos los idiomas se hayan procesado correctamente.
Para obtener un programa completo de consulta periódica y descarga, usa la guía de inicio rápido. Para gestionar las revisiones del contenido de origen y decidir cuándo volver a intentarlo, consulta crear un flujo de trabajo de traducción.