Autenticação da API

Autentique os pedidos à API e conceda o acesso necessário para cada operação.

Envie uma chave de API da Lingo.dev no cabeçalho X-API-Key. Utilize https://api.lingo.dev/v2 como URL base para as referências da API nesta secção.

http
GET /v2/organizations/YOUR_ORGANIZATION_ID/localization/jobs HTTP/1.1
Host: api.lingo.dev
X-API-Key: YOUR_API_KEY

Crie uma chave em Chaves de API. Guarde-a no ambiente do servidor ou num gestor de segredos. Não a inclua em repositórios, pacotes de código para o navegador, URLs ou documentos de origem.

Escolher uma credencial #

Uma chave pessoal utiliza a associação à organização e as permissões atuais do respetivo utilizador. Uma chave de serviço da organização pertence à organização e é adequada para serviços sem intervenção humana. As permissões concedidas por função e por recurso determinam o acesso da chave; uma permissão explícita mais restrita não reduz o acesso já conferido pela função.

A API também aceita o token de acesso da sessão de um utilizador com sessão iniciada como Authorization: Bearer <access-token>. Um revisor pode utilizar a sua sessão de utilizador ou chave pessoal para submeter decisões de revisão. As chaves de serviço não podem tomar decisões de revisão humana, pois essas ações têm de identificar uma pessoa.

Utilize apenas um método de autenticação por pedido. Os nomes dos cabeçalhos não distinguem maiúsculas de minúsculas.

Selecionar a organização e o motor #

As rotas limitadas ao âmbito de uma organização incluem orgId no caminho. Para encontrar os IDs das organizações de um utilizador ou de uma chave pessoal, consulte GET /v2/users/me/memberships. No caso de uma chave de serviço, utilize a organização à qual a chave pertence. Os IDs dos motores identificam o motor configurado no Studio; utilize GET /v2/organizations/:orgId/engines para listar os motores acessíveis.

Criar, iniciar, consultar e transferir um trabalho de localização exige acesso à respetiva organização e acesso de tradução ao respetivo motor. O aprovisionamento exige permissão para editar ou criar o motor e para criar as orientações solicitadas. A revisão de traduções segue as permissões e o encaminhamento do revisor.

Fornecer um ID de organização ou de motor não concede acesso. Um recurso fora do âmbito de acesso de quem faz o pedido pode devolver 404. Por isso, quando não for possível encontrar um recurso conhecido, confirme tanto o ID como as permissões de quem faz o pedido.

Diagnosticar uma falha de acesso #

Leia a resposta com os detalhes do problema e o respetivo código de estado HTTP. Um 401 indica uma credencial em falta, inválida ou expirada. Um 402 indica uma condição relacionada com a faturação ou o plano, incluindo uma chave de serviço desativada após uma mudança para um nível inferior de RBAC. Um 403 indica uma permissão recusada ou a necessidade de uma identidade de utilizador. A configuração do motor e os limites da conta exigem correções próprias.

Para diagnóstico, conserve o type do problema, o código de estado e os IDs de recursos que não sejam secretos. Nunca registe o cabeçalho de autenticação.

Substituir uma chave #

Crie a 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 obter um trabalho existente e transferir um resultado. Conserve os IDs dos trabalhos registados: a substituição das credenciais não altera a identidade dos trabalhos.