Autentique-se com a API

Referência completa da API: developer.universally.com contém a especificação ativa para a API do Tradutor e a API da Plataforma, com todos os campos, códigos de status e exemplos de resposta. Esta página cobre o que vale a pena saber sobre isso.

Cada requisição da API Universally é autenticada com uma chave de API passada no cabeçalho HTTP X-API-Key.

X-API-Key: your_api_key_here

Dois tipos de chave

Elas não são intercambiáveis, e o envio da chave errada retorna API_KEY_INVALID. Qual delas você precisa depende do serviço que você está chamando.

Traduzir conteúdo usa a chave do projeto. Gerenciar projetos, idiomas e strings armazenadas a partir de suas próprias ferramentas usa uma chave de API da Plataforma.

Obtendo uma chave de projeto

Uma chave de projeto é gerada automaticamente quando você cria um projeto. Abra o projeto e vá para Configurações de API para visualizar, copiar ou regenerar. Visualizá-la requer a permissão de chaves de API. Não há endpoint para emitir uma.

Regenerar a chave invalida imediatamente a anterior. Qualquer integração que use a chave antiga começará a receber API_KEY_INVALID até que você a atualize.

Obtendo uma chave de API da Plataforma

Abra o espaço de trabalho e vá para Chaves de API, então crie uma. Veja Encontre sua chave de API para os campos, incluindo a expiração e a lista de permissões, e note que a chave é mostrada uma vez e não pode ser recuperada depois.

Mantendo sua chave segura

Sua chave pode gastar as palavras traduzidas do seu plano, então trate-a como uma senha:

• Envie requisições de um servidor, uma função de edge ou um job de backend. Nunca incorpore a chave em JavaScript de navegador, pacotes de aplicativos móveis ou qualquer cliente que um usuário possa inspecionar.
• Mantenha a chave fora do controle de versão. Carregue-a de uma variável de ambiente ou de um gerenciador de segredos.
• Se um cliente (um navegador ou aplicativo) precisar de conteúdo traduzido, roteie a requisição através do seu próprio backend para que a chave permaneça no lado do servidor.

Como o Translator permite requisições cross-origin, uma chave vazada pode ser usada de qualquer lugar. Se você suspeitar que sua chave foi exposta, regenere-a no painel.

Verificando uma chave

Para verificar se uma chave é válida e ver a qual site ela pertence, chame o endpoint de verificação no serviço de API:

curl https://api.universally.com/connect/keys/verify \
  -H "X-API-Key: your_api_key_here"

{
  "success": true,
  "data": {
    "valid": true,
    "siteId": "site_123",
    "domain": "example.com"
  },
  "message": "API key is valid.",
  "code": "KEY_VALID"
}

Isso é útil durante a configuração para confirmar se uma integração está conectada ao site correto antes de enviar conteúdo real.

Erros de autenticação

Veja Erros e Limites para a tabela completa.