Consultar um trabalho de tradução
Confira os destinos dos documentos, aguarde a conclusão e baixe os resultados disponíveis.
Consulte um trabalho usando o id retornado na criação:
GET /v2/localization/jobs/:id
X-API-Key: YOUR_API_KEYA resposta descreve todos os documentos e seus idiomas de destino. Ela pode incluir destinos concluídos enquanto outros ainda estão em execução ou apresentaram falha.
Campos do trabalho #
| Campo | Significado |
|---|---|
id, organizationId, engineId | Identificação do trabalho, organização proprietária e engine. |
sourceLocale | Idioma de origem. |
trigger | Origem, como api, cli, ci ou uma integração. |
status | Estado do trabalho identificado por uma etiqueta, descrito abaixo. |
createdAt, updatedAt | Cadeias de caracteres com data e hora no padrão ISO. |
createdBy | Informações sobre quem criou o trabalho, ou null quando indisponíveis. Uma chave pessoal é atribuída ao usuário a quem pertence. |
documents | Documentos, seus formatos e endereços de origem, além do progresso dos destinos. |
uploads | Endereços dos artefatos ausentes e URLs de envio enquanto o trabalho estiver pendente; vazio após o início do trabalho. |
Estados do trabalho #
status._tag | O que fazer |
|---|---|
Pending | Envie os artefatos ausentes e chame /start. |
Running | Consulte novamente mais tarde; confira as etapas dos destinos para verificar se há processamento em andamento ou espera por revisão. |
Completed | Baixe e examine os resultados. Confira os avisos das etapas como parte da aceitação. |
Failed | Leia status.message e confira as falhas dos destinos. Os destinos concluídos continuam disponíveis. |
Cancelled | O processamento foi interrompido. Confira se há resultados já concluídos nos destinos. |
Completed, Failed e Cancelled são estados finais do trabalho. Uma falha parcial ocorre quando um trabalho com falha tem tanto destinos concluídos quanto destinos com falha.
Campos de documentos e destinos #
Cada documento contém id, key, format, source, previousSource e targets. source é um endereço de artefato mesmo quando o JSON foi fornecido diretamente na solicitação. previousSource é null quando ausente.
Cada destino contém:
| Campo | Significado |
|---|---|
locale | Idioma de destino. |
previousTranslation | Endereço do artefato anterior do destino, ou null. |
status | Pending, Completed ou Failed no campo _tag. |
stages | Progresso das etapas, incluindo estado e contagens de unidades. |
O estado de um destino concluído contém artifact e downloadUrl; o de um destino com falha contém message. Este trecho da resposta mostra o estado de um destino concluído:
{
"_tag": "Completed",
"artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}Use o endereço e a URL que foram de fato retornados. A URL é relativa a https://api.lingo.dev e exige autenticação; não é um link público assinado para download. O download retorna os bytes do arquivo no formato do documento.
Vários destinos podem compartilhar um artefato. Um catálogo de strings da Apple reúne os idiomas solicitados em um único arquivo .xcstrings; salve esse resultado combinado apenas uma vez e confira as entradas de cada idioma, em vez de tratar cada download como um catálogo separado de um único idioma.
Consultar periodicamente e coletar #
Consulte o trabalho em intervalos definidos, por exemplo, a cada dois segundos, e estabeleça um prazo máximo na aplicação. Se uma consulta falhar temporariamente, mantenha o ID e tente novamente, aumentando os intervalos entre as tentativas. Encerrar a espera não cancela o processamento no servidor. A revisão humana pode levar muito mais tempo do que o curto tempo limite de uma solicitação da aplicação.
Baixe um destino assim que seu estado for Completed. Se a aplicação precisar publicar todos os idiomas juntos, aguarde todos os destinos necessários e aplique essa regra de publicação no seu próprio armazenamento. Um único arquivo concluído não comprova que todos os idiomas foram processados com sucesso.
Para obter um programa completo de consulta periódica e download, use o guia de início rápido. Para lidar com revisões do conteúdo de origem e decidir quando tentar novamente, consulte criar um workflow de tradução.