Trabajos de traducción

Crea e inicia trabajos con uno o más documentos e idiomas de destino.

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

Todas las rutas que se muestran 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 #

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

Cada documento tiene:

CampoObligatorioDescripción
keySíRuta lógica o nombre de archivo que no puede estar vacío ni repetirse 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.
previousTranslationsNoArreglo de { "locale": "de", "artifact": "SHA256" }. El valor predeterminado es []; cada idioma debe ser único y estar entre los destinos de este documento.
targetLocalesNoSelección no vacía de idiomas sin duplicados que reemplaza los idiomas de destino para este documento. Si se omite o se usa null, se usan los idiomas de destino del trabajo.

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

Idempotencia #

Envía un Idempotency-Key no vacío de hasta 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 solicitud sin cambios si no tienes certeza sobre la respuesta de creación.

Al reutilizar una clave, se devuelve el trabajo creado originalmente con ella. Esto no actualiza los documentos ni los idiomas de ese trabajo. Usa una clave nueva si cambia el trabajo. Una opción de ejecución incompatible 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. El arreglo uploads enumera los artefactos de entrada faltantes como { "address": "...", "uploadUrl": "..." }.

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

Cargar e iniciar #

Carga cada artefacto faltante en su uploadUrl mediante un PUT autenticado que contenga los bytes originales. Luego 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. Es seguro repetir el inicio del mismo trabajo y hacerlo puede recuperar un envío cuyo resultado es incierto; no crea otro trabajo ni vuelve a ejecutar uno que ya terminó.

Al iniciar, se verifican los artefactos cargados, la configuración del motor y los límites de la cuenta. ArtifactsNotUploaded (409) enumera las entradas faltantes. Alcanzar el límite diario de tokens (429) o no tener suficientes créditos deja el trabajo pendiente; resuelve el problema antes de volver a iniciarlo. Consulta errores.

Configurar las etapas del proceso #

Configura el proceso del motor antes de iniciar el trabajo. La configuración se captura al inicio. Las etapas de destino resultantes muestran el trabajo que efectivamente se seleccionó según lo que permite el plan.

Recopilar resultados y recuperarse de errores #

Obtén el trabajo para consultar 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 errores.

Un trabajo fallido puede contener destinos completados. Conserva esos resultados y, una vez corregida la causa, envía solo el trabajo que necesite regenerarse con una nueva clave de idempotencia. Conserva las revisiones del contenido 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 solicitudes por motor, estado, desencadenante o clave de servicio.