Você tem conteúdo em um idioma e usuários que leem em vários. A API existe para fechar essa lacuna de forma programática: você envia o texto, recebe de volta traduzido, e toda tradução passa por um engine de localização que você configura uma única vez. O engine aplica seu glossário, sua voz da marca, suas instruções e a seleção de modelo por idioma em todas as chamadas — para que o resultado saia do jeito que sua equipe definiu, e não do jeito que um modelo genérico supôs.
Isso deixa só uma decisão: quanto você precisa traduzir de uma vez. Traduza um único idioma em uma solicitação e leia o resultado direto na resposta, ou passe vários idiomas para a plataforma e deixe que ela traduza cada um como um job independente em segundo plano enquanto seu app continua responsivo. Esta página cobre a URL base, essa decisão e para onde seguir depois.
O que esta API pressupõe
Esta é a referência para traduzir de forma programática. Ela pressupõe que você decidiu localizar a partir do seu próprio código ou pipeline — não pelo dashboard — e que você tem uma chave de API. É novo na plataforma? O conceito de engine de localização é o primeiro que você precisa entender; tudo aqui passa por ele.
Nesta página
- URL base
- Duas formas de traduzir
- Assíncrono: vários idiomas como jobs
- Síncrono: uma solicitação, uma resposta
- Próximos passos
URL base#
Todos os endpoints REST desta referência ficam sob um único host:
https://api.lingo.devToda solicitação também leva um cabeçalho, X-API-Key. A chave é vinculada à organização e exibida uma única vez no momento da criação; as regras completas para enviá-la estão em Authentication, e o que é retornado quando uma solicitação é rejeitada está em Errors and status codes.
Duas formas de traduzir#
O mesmo engine, com o mesmo glossário e a mesma voz da marca, está por trás dos dois modos. O que muda é quem fica com a espera.
Uma chamada síncrona traduz um par de idiomas e retorna os dados traduzidos na resposta. É a opção mais simples — uma solicitação, uma resposta, nenhum endpoint para operar do seu lado — e é a escolha certa quando você precisa de um único idioma e pode esperar por uma ida e volta.
Mas conteúdo raramente é publicado em um único idioma. Um módulo de treinamento chega a 14 idiomas; uma entrada de CMS se espalha por todos os mercados em que você vende. Faça uma chamada síncrona por idioma e você assume 14 idas e voltas, além da lógica de retry quando uma falha; espere por uma única chamada síncrona para todos eles e você fica travado no mais lento. Por isso, a API também oferece um modo assíncrono: você faz POST do conteúdo uma vez com os idiomas de destino, recebe um 202 imediatamente, e a plataforma traduz cada idioma como um job independente em segundo plano — cuidando dos retries e do isolamento de falhas enquanto seu app continua responsivo.
Use o modo assíncrono quando o job for grande demais, lento demais ou envolver idiomas demais para bloquear. Use o modo síncrono quando um único par de idiomas em uma única resposta for tudo o que você precisa. As páginas assíncronas vêm primeiro abaixo porque carregam mais coisas, mas nenhuma delas é a API "de verdade" — são apenas dois formatos do mesmo engine.
Assíncrono: vários idiomas como jobs#
Uma solicitação, todos os idiomas, resultados assim que ficarem prontos. A API assíncrona recebe uma única submissão, cria um job por idioma de destino e entrega cada resultado no momento em que termina — por webhook ou WebSocket — sem bloquear seu app em nenhuma etapa.
Síncrono: uma solicitação, uma resposta#
Quando você precisa de um par de idiomas e pode esperar pela ida e volta, chame um endpoint síncrono e leia o resultado direto na resposta — sem endpoint de webhook, sem polling.
Próximos passos#
Seja qual for o modo escolhido, o engine por trás dele é seu para ajustar. Gere uma chave e depois defina o que o engine faz em cada chamada — o modelo que ele seleciona por idioma, os termos que ele deve traduzir exatamente.
