Autenticação da API
Autentique as requisições à API e conceda o acesso necessário para cada operação.
Envie uma chave de API do Lingo.dev no cabeçalho X-API-Key. Use https://api.lingo.dev/v2 como URL base para as referências da API nesta seção.
GET /v2/organizations/YOUR_ORGANIZATION_ID/localization/jobs HTTP/1.1
Host: api.lingo.dev
X-API-Key: YOUR_API_KEYCrie uma chave em Chaves de API. Armazene-a no ambiente do servidor ou em um gerenciador de segredos. Não a inclua em repositórios, pacotes de código enviados ao navegador, URLs ou documentos de origem.
Escolher uma credencial #
Uma chave pessoal usa o vínculo e as permissões atuais do usuário. Uma chave de serviço da organização pertence à organização e é indicada para serviços que operam sem intervenção humana. As permissões concedidas por função e por recurso determinam seu acesso; uma concessão explícita mais restrita não reduz o acesso já garantido pela função.
A API também aceita o token de acesso da sessão de um usuário autenticado como Authorization: Bearer <access-token>. Um revisor pode usar sua sessão de usuário ou chave pessoal para enviar decisões de revisão. Chaves de serviço não podem tomar decisões de revisão humana, pois essas ações precisam identificar uma pessoa.
Use um único método de autenticação por requisição. Os nomes dos cabeçalhos não diferenciam maiúsculas de minúsculas.
Selecionar a organização e o engine #
As rotas com escopo de organização incluem orgId no caminho. Para encontrar os IDs das organizações de um usuário ou de uma chave pessoal, consulte GET /v2/users/me/memberships. Para uma chave de serviço, use a organização à qual ela pertence. Os IDs de engine identificam o engine configurado no Studio; liste os engines acessíveis com GET /v2/organizations/:orgId/engines.
Criar, iniciar, consultar e baixar um trabalho de localização exige acesso à organização desse trabalho e acesso de tradução ao engine correspondente. O provisionamento exige permissão para editar ou criar o engine e para criar as orientações solicitadas. A revisão de traduções segue as permissões e o roteamento do revisor.
Informar um ID de organização ou de engine não concede acesso. Um recurso fora do escopo do solicitante pode retornar 404. Por isso, confirme tanto o ID quanto as permissões do solicitante quando um recurso conhecido não for encontrado.
Diagnosticar uma falha de acesso #
Leia a resposta com os detalhes do problema, além do código de estado HTTP. Um 401 indica uma credencial ausente, inválida ou expirada. Um 402 indica uma condição de cobrança ou de plano, incluindo uma chave de serviço desativada após uma redução do nível de RBAC. Um 403 indica uma permissão negada ou a exigência de uma identidade de usuário. A configuração do engine e os limites da conta exigem correções específicas.
Para o diagnóstico, guarde o type do problema, o estado e os IDs de recursos que não sejam secretos. Nunca registre o cabeçalho de autenticação em logs.
Fazer a rotação de uma chave #
Crie uma nova chave, conceda o acesso necessário e atualize o segredo do serviço. Antes de revogar a chave antiga, verifique se a nova chave permite consultar um trabalho existente e baixar um resultado. Mantenha os IDs dos trabalhos registrados: a rotação de credenciais não altera a identidade deles.