Consultar uma tarefa de tradução

Verifique os destinos dos documentos, aguarde a conclusão e descarregue os resultados disponíveis.

Consulte uma tarefa com o id devolvido na criação:

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

A resposta descreve todos os documentos e os respetivos idiomas de destino. Pode incluir destinos concluídos enquanto outros ainda estão em execução ou já falharam.

Campos da tarefa #

CampoSignificado
id, organizationId, engineIdIdentificação da tarefa, organização proprietária e motor.
sourceLocaleIdioma de origem.
triggerOrigem, como api, cli, ci ou uma integração.
statusEstado da tarefa identificado por uma etiqueta, descrito abaixo.
createdAt, updatedAtCadeias de caracteres com data e hora no formato ISO.
createdByInformações sobre o criador, ou null quando não estão disponíveis. Uma chave pessoal é atribuída ao respetivo utilizador.
documentsDocumentos, respetivos formatos e endereços de origem, e progresso dos destinos.
uploadsEndereços dos artefactos em falta e URLs de carregamento enquanto a tarefa está pendente; vazio após o início da tarefa.

Estados da tarefa #

status._tagO que fazer
PendingCarregue os artefactos em falta e invoque /start.
RunningVolte a consultar mais tarde; verifique as etapas dos destinos para saber se estão em processamento ou a aguardar revisão.
CompletedDescarregue e verifique os resultados. Verifique os avisos das etapas como parte do processo de aceitação.
FailedConsulte status.message e as falhas dos destinos. Os destinos concluídos continuam disponíveis.
CancelledO processamento parou. Verifique se os destinos têm resultados já concluídos.

Completed, Failed e Cancelled são estados finais da tarefa. Uma falha parcial corresponde a uma tarefa que falhou, com alguns destinos concluídos e outros com falhas.

Campos dos documentos e dos destinos #

Cada documento contém id, key, format, source, previousSource e targets. source é um endereço de artefacto, mesmo quando o pedido forneceu JSON em linha. previousSource tem o valor null quando está ausente.

Cada destino contém:

CampoSignificado
localeIdioma de destino.
previousTranslationEndereço do artefacto de destino anterior, ou null.
statusPending, Completed ou Failed no respetivo campo _tag.
stagesProgresso das etapas, incluindo o estado e as contagens de unidades.

O estado de um destino concluído contém artifact e downloadUrl; o estado de um destino que falhou contém message. Este excerto da resposta mostra o estado de um destino concluído:

json
{
  "_tag": "Completed",
  "artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Utilize o endereço e o URL efetivamente devolvidos. O URL é relativo a https://api.lingo.dev e requer autenticação; não é uma ligação de descarga pública e assinada. A descarga devolve os bytes do ficheiro no formato do documento.

Vários destinos podem partilhar um artefacto. Um Apple String Catalog reúne os idiomas pedidos num único ficheiro .xcstrings; guarde esse resultado combinado apenas uma vez e verifique as respetivas entradas de idioma, em vez de tratar cada descarga como um catálogo separado de um único idioma.

Consultar periodicamente e recolher #

Consulte a tarefa a intervalos definidos, por exemplo, de dois em dois segundos, com um prazo limite definido na aplicação. Se uma consulta falhar temporariamente, mantenha o ID e tente novamente com intervalos progressivamente maiores. Terminar a espera não cancela o processamento no servidor. A revisão humana pode demorar bastante mais do que um tempo limite curto para um pedido da aplicação.

Descarregue um destino assim que o respetivo estado for Completed. Se a sua aplicação precisar de publicar todos os idiomas em simultâneo, aguarde por todos os destinos necessários e aplique essa regra de publicação no seu próprio armazenamento. Um único ficheiro concluído não comprova que todos os idiomas foram processados com êxito.

Para obter um programa completo de consulta periódica e descarga, utilize o guia de início rápido. Para saber como gerir revisões do conteúdo de origem e decidir quando repetir as tentativas, consulte criar um workflow de tradução.