Trabajos de traducción

Crea e inicia trabajos con uno o varios documentos e idiomas de destino.

Un trabajo traduce documentos a través de un único motor de localización. Cada documento tiene una clave estable y un destino por cada idioma solicitado. Usa JSON en línea para el contenido en memoria o direcciones de artefactos para los archivos.

Todas las rutas que se indican a continuación usan https://api.lingo.dev y autenticación de API.

Crear un trabajo #

http
POST /v2/organizations/:orgId/localization/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
Idempotency-Key: order-confirmation-v3-de-fr
json
{
  "engineId": "YOUR_ENGINE_ID",
  "sourceLocale": "en",
  "targetLocales": ["de", "fr"],
  "documents": [
    {
      "key": "order-confirmation.json",
      "format": { "type": "json" },
      "source": { "content": { "subject": "Your order is confirmed" } }
    }
  ]
}

Campos de la solicitud #

CampoObligatorioSignificado
engineIdSíMotor de la organización con el que puede traducir quien realiza la llamada.
sourceLocaleSíIdioma de origen.
targetLocalesSíLista no vacía de idiomas de destino sin duplicados. Un documento no puede tener como destino su propio idioma de origen.
documentsSíLista no vacía de documentos con valores key únicos.
originIdNoIdentificador no vacío, de hasta 512 caracteres, de la ubicación de los documentos; por ejemplo, github:acme/web. Vincula los cambios posteriores procedentes de ese origen con la medición de la traducción.

Cada documento tiene:

CampoObligatorioSignificado
keySíRuta lógica o nombre de archivo que no puede estar vacío y debe ser único dentro de este trabajo. Mantén el mismo valor entre revisiones.
formatSíObjeto de formato con un type y un options específico del formato.
sourceSíDirección de artefacto SHA-256 o { "content": { ... } } para JSON en línea.
previousSourceNoDirección del artefacto de origen anterior. Omítela o usa null si es la primera traducción.
previousTranslationsNoLista de { "locale": "de", "artifact": "SHA256" }. El valor predeterminado es []; cada idioma debe ser único y figurar entre los destinos de este documento.
targetLocalesNoLista de idiomas no vacía y sin duplicados que sustituye a la del trabajo para este documento. Si se omite o se usa null, se utilizan los idiomas de destino del trabajo.

Si usas keyScope o termScope, proporciona una traducción anterior para cada destino. Consulta formatos y actualizaciones de documentos.

Idempotencia #

Envía un Idempotency-Key no vacío de un máximo de 255 caracteres. Las claves se limitan al ámbito del motor; el prefijo content-sync: está reservado. Conserva la clave junto con la solicitud original y repite esa misma solicitud sin cambios si la respuesta de creación no es concluyente.

Al reutilizar una clave, se devuelve el trabajo creado originalmente con ella. No se actualizan los documentos ni los idiomas de ese trabajo. Usa una clave nueva si cambia el trabajo que quieres realizar. Una opción de ejecución en conflicto puede generar LocalizationJobIdempotencyKeyReused (422).

Respuesta de creación #

Si la creación se completa correctamente, devuelve HTTP 200 y la respuesta del trabajo, normalmente con status: { "_tag": "Pending" }. Guarda id de forma persistente antes de continuar. La lista uploads indica los artefactos de entrada que faltan como { "address": "...", "uploadUrl": "..." }.

La creación almacena el contenido de origen en línea. No inicia la traducción, aunque uploads esté vacío.

Subir e iniciar #

Sube cada artefacto que falte a su uploadUrl mediante un PUT autenticado que contenga los bytes originales. A continuación, llama a:

http
POST /v2/localization/jobs/:id/start
X-API-Key: YOUR_API_KEY

La solicitud de inicio no tiene cuerpo. Su respuesta HTTP 200 contiene el registro actual del trabajo. Puedes repetir el inicio del mismo trabajo de forma segura para recuperarte de un envío cuyo resultado no se haya confirmado; no se crea otro trabajo ni se vuelve a ejecutar uno ya finalizado.

Al iniciar el trabajo, se comprueban los artefactos subidos, la configuración del motor y los límites de la cuenta. ArtifactsNotUploaded (409) indica las entradas que faltan. Alcanzar el límite diario de tokens (429) o no disponer de créditos suficientes deja el trabajo pendiente; resuelve la situación antes de volver a iniciarlo. Consulta errores.

Configurar las etapas del flujo de procesamiento #

Configura el flujo de procesamiento del motor antes de iniciar el trabajo. La configuración se captura en el momento del inicio. Las etapas resultantes de cada destino muestran el trabajo que se ha seleccionado realmente, según las funciones disponibles en el plan.

Recoger resultados y recuperarse de errores #

Consulta el trabajo para examinar cada destino y descargar los archivos completados. Usa el progreso de las etapas para distinguir entre el trabajo del modelo, las esperas de revisión, el trabajo omitido y los fallos.

Un trabajo fallido puede contener destinos completados. Conserva esos resultados y, tras corregir la causa, envía solo el trabajo que haya que regenerar con una nueva clave de idempotencia. Conserva las revisiones de origen junto con los ID de los trabajos para que una entrega posterior no sobrescriba traducciones más recientes.

Lista los trabajos para encontrar envíos por motor, estado, desencadenante o clave de servicio.