Tem conteúdo num idioma e utilizadores que leem em muitos. A API existe para colmatar essa diferença de forma programática: envia texto, recebe-o de volta traduzido, e cada tradução passa por um motor de localização que configura uma vez. O motor aplica o seu glossário, a voz da marca, as instruções e a seleção de modelos por idioma em cada chamada — para que o resultado soe como a sua equipa definiu, e não como um modelo genérico adivinhou.
Isto deixa apenas uma decisão: quanto precisa de traduzir de uma só vez. Traduza um único idioma num pedido e leia o resultado diretamente na resposta, ou entregue à plataforma vários idiomas e deixe-a traduzir cada um como uma tarefa independente em segundo plano, enquanto a sua aplicação se mantém responsiva. Esta página explica o URL base, essa decisão e para onde deve seguir a seguir.
O que esta API pressupõe
Esta é a Referência para traduzir de forma programática. Parte do princípio de que decidiu localizar a partir do seu próprio código ou pipeline — e não através do dashboard — e que tem uma chave de API. É novo na plataforma? O conceito de motor de localização é o primeiro que deve compreender; tudo aqui passa por ele.
Nesta página
- URL base
- Duas formas de traduzir
- Assíncrono: vários idiomas como tarefas
- Síncrono: um pedido, uma resposta
- Próximos passos
URL base#
Todos os endpoints REST desta Referência estão alojados no mesmo host:
https://api.lingo.devCada pedido inclui também um cabeçalho, X-API-Key. A chave está associada à organização e só é mostrada uma vez, no momento da criação; as regras completas para a enviar estão em Authentication, e o que é devolvido quando um pedido é rejeitado está em Errors and status codes.
Duas formas de traduzir#
O mesmo motor, o mesmo glossário e a mesma voz da marca estão por detrás de ambos os modos. O que muda é quem fica à espera.
Uma chamada síncrona traduz um par de idiomas e devolve os dados traduzidos na resposta. É a opção mais simples — um pedido, uma resposta, nenhum endpoint para executar do seu lado — e é a escolha certa quando precisa de um único idioma e pode esperar por uma ida e volta.
Mas o conteúdo raramente é publicado num só idioma. Um módulo de formação chega a 14 línguas; uma entrada de CMS distribui-se por todos os mercados em que vende. Se fizer uma chamada síncrona por idioma, fica com 14 idas e voltas e com a lógica de repetição quando uma falha; se esperar por uma única chamada síncrona para todos, fica bloqueado pelo mais lento. Por isso, a API também oferece um modo assíncrono: faz POST do seu conteúdo uma vez com os idiomas de destino, recebe um 202 imediatamente, e a plataforma traduz cada idioma como uma tarefa independente em segundo plano — tratando das repetições e do isolamento de falhas enquanto a sua aplicação se mantém responsiva.
Opte pelo modo assíncrono quando a tarefa for demasiado grande, demasiado lenta ou envolver idiomas a mais para ficar à espera. Opte pelo modo síncrono quando tudo o que precisa é de um par de idiomas numa única resposta. As páginas assíncronas aparecem primeiro abaixo porque abrangem mais, mas nenhuma é a API "real" — são duas formas do mesmo motor.
Assíncrono: vários idiomas como tarefas#
Um pedido, todos os idiomas, resultados à medida que ficam prontos. A API assíncrona recebe uma submissão, cria uma tarefa por idioma de destino e entrega cada resultado no momento em que fica concluído — por webhook ou WebSocket — sem bloquear a sua aplicação em nenhum momento.
Síncrono: um pedido, uma resposta#
Quando precisa de um par de idiomas e pode esperar pela ida e volta, chame um endpoint síncrono e leia o resultado diretamente na resposta — sem endpoint de webhook, sem polling.
Próximos passos#
Qualquer que seja o modo que escolher, o motor por detrás dele é seu para afinar. Gere uma chave e depois defina o que o motor faz em cada chamada — o modelo que seleciona por idioma, os termos que tem de traduzir exatamente.
