API

Traduza JSON e arquivos, acompanhe o progresso e baixe as traduções concluídas pelo seu servidor.

Use a API da Lingo.dev para traduzir o conteúdo da sua aplicação. Um trabalho de localização reúne um engine, um idioma de origem, idiomas de destino e um ou mais documentos. Cada documento acompanha um destino para cada idioma solicitado. A maioria dos formatos gera arquivos de destino separados; os Catálogos de Strings da Apple reúnem os idiomas em um único arquivo.

A URL base da API é https://api.lingo.dev/v2. Mantenha as credenciais da API no seu servidor. Comece com sua primeira solicitação de tradução para traduzir duas mensagens e salvar o resultado.

Escolha o tipo de entrada #

Seu conteúdoComece aqui
Um objeto JSON já armazenado na sua aplicaçãoTraduzir JSON. Envie o objeto diretamente na solicitação de criação.
Arquivos como JSON, Markdown, HTML ou recursos para dispositivos móveisTraduzir documentos. Envie os bytes originais e baixe os arquivos no mesmo formato.
Vários documentos ou idiomas de destinoCriar um trabalho de tradução. Um trabalho pode conter tanto JSON incorporado à solicitação quanto arquivos enviados.

As três opções seguem o mesmo ciclo de vida:

  1. Crie um trabalho e salve o ID junto com a versão do conteúdo de origem.
  2. Envie todos os artefatos listados no array uploads da resposta. Os conteúdos de origem em JSON incorporados à solicitação são armazenados durante a criação.
  3. Inicie o trabalho.
  4. Consulte o progresso até que os destinos necessários dos documentos estejam concluídos.
  5. Baixe cada destino concluído pelo respectivo status.downloadUrl.

A criação salva o trabalho a ser realizado; ao iniciá-lo, o trabalho é aceito para execução e o processamento começa. Uma resposta de criação bem-sucedida não é um resultado traduzido.

Estime o trabalho antes de criá-lo quando precisar verificar o reaproveitamento e o custo aproximado.

Configure a tradução #

Selecione um engine explicitamente com engineId. Ele fornece modelos, glossários, regras e voz da marca, além do pipeline de tradução. A chave de API precisa ter acesso à tradução nesse engine.

Para JSON, adicione contexto específico do documento, dicas e caminhos protegidos por meio de format.options. Para uma versão posterior, forneça o conteúdo de origem e as traduções anteriores para reaproveitar o conteúdo que não mudou.

A revisão humana permite que revisores autorizados aprovem ou editem traduções elegíveis antes que o pipeline prossiga. O guia do workflow de revisão explica como conectar envio, revisão e entrega.

Mantenha o estado da aplicação junto ao trabalho #

Armazene de forma persistente o ID do trabalho, a versão do conteúdo de origem, as chaves dos documentos e os idiomas solicitados antes de continuar. Use o cabeçalho Idempotency-Key ao criar um trabalho para poder repetir a solicitação, caso a resposta seja incerta, sem criar outro trabalho. Recupere o trabalho existente antes de enviar um substituto.

Baixe os destinos concluídos mesmo que outro destino falhe. Publique um resultado somente se ele ainda corresponder à versão do conteúdo de origem esperada pela sua aplicação. Criar um workflow de tradução explica como fazer essa coordenação.

Consulte autenticação, erros e o catálogo de erros para saber mais sobre acesso e recuperação.

Prepare e aprimore um engine #

O provisionamento preenche glossários, regras e voz da marca com base no conteúdo de sites ou em texto. As sugestões de engine transformam comentários em propostas que você pode analisar e aplicar. Revise as orientações geradas antes de usá-las como base para a tradução.