Pular para o conteúdo principal

Token de API (longa duração)

O token de API é uma credencial de longa duração para integrações servidor a servidor. Com ele, sua integração autentica todas as requisições com um único valor fixo, sem precisar fazer login com e-mail e senha nem renovar o token de acesso a cada hora.

É a forma recomendada de autenticar automações, ERPs e qualquer integração que roda sem uma pessoa por trás. O login com e-mail e senha descrito em Autenticação continua funcionando normalmente.

Token de APIE-mail e senha
O que vai no AuthorizationBearer ih_... (o próprio token)Bearer <accessToken> obtido no /login
Duraçãonão expira; vale até ser revogadoaccessToken de 1 hora, refreshToken de 30 dias
Renovaçãonão é necessáriasua integração chama /refresh ou faz novo login
Loginnão háPOST https://auth.inhire.app/login

Gerando o token​

Somente usuários com perfil Owner podem gerar e gerenciar tokens.

  1. Acesse Configurações > Usuário de API.
  2. Usuário de API novo: clique em Adicionar Usuário. O token é gerado junto com o usuário e exibido na mesma tela.
  3. Usuário de API existente: abra o menu de ações (⋯) do usuário e clique em Token de API > Gerar token.
aviso

O token é exibido apenas uma vez. Copie e guarde em um cofre de segredos (por exemplo, o gerenciador de segredos do seu provedor de nuvem). A InHire armazena somente um hash do token e não consegue recuperá-lo depois. Se ele for perdido, gere um novo token.

O token tem o formato ih_<identificador do usuário>_<parte aleatória>. Cada usuário de API pode ter um token ativo por vez.

informação

Se a opção Token de API não aparecer no menu de ações, fale com o seu contato na InHire para habilitá-la na sua conta.

Usando o token​

Envie o token no header Authorization, no formato Bearer, e o identificador do cliente no header X-Tenant, em todas as requisições:

curl -X POST https://api.inhire.app/jobs/paginated/lean \
-H "Authorization: Bearer ih_..." \
-H "X-Tenant: cliente" \
-H "Content-Type: application/json" \
-d '{ "limit": 10 }'

O exemplo usa o endpoint Obter vagas paginadas, mas o token vale para qualquer endpoint autenticado da API.

O X-Tenant é o mesmo identificador usado no login: o subdomínio do cliente na plataforma InHire (https://cliente.inhire.app -> cliente). Ele é obrigatório com token de API.

Não é preciso chamar nenhum endpoint de login, troca ou renovação: o token vai direto em cada requisição para https://api.inhire.app.

Revogando e regenerando​

Em Configurações > Usuário de API, abra o menu de ações (⋯) do usuário e clique em Token de API:

  • Revogar token invalida o token atual. O usuário fica sem token ativo até um novo ser gerado.
  • Regenerar token invalida o token atual e gera um novo na mesma ação, exibido apenas uma vez.

A tela também mostra quando o token foi criado e quando foi usado pela última vez, útil para confirmar se uma integração ainda está ativa antes de revogar.

aviso

A revogação pode levar até 5 minutos para valer em todas as requisições. O mesmo prazo vale ao desativar ou excluir o usuário de API: a partir daí, o token deixa de ser aceito.

Restrição por IP e limites de uso​

O token de API está sujeito às mesmas regras do usuário de API ao qual pertence:

  • IPs autorizados: se o usuário de API tiver IPs autorizados configurados, requisições com o token vindas de outros IPs recebem 403.
  • Limites de uso: as requisições feitas com o token contam para o limite da sua conta, descrito em Limites de uso.

Erros de autenticação​

StatusMensagemO que fazer
401Missing X-Tenant header for API token.Envie o header X-Tenant com o identificador do cliente.
401Invalid API token.O token está incorreto ou foi revogado, o usuário de API foi desativado ou excluído, ou a conta está suspensa. Confira o valor ou gere um novo token.
403IP address not allowed for this API account.A requisição saiu de um IP fora dos IPs autorizados do usuário de API. Inclua o IP na lista ou faça a requisição a partir de um IP autorizado.
502Unable to verify API token.Falha temporária ao validar o token. Tente novamente após alguns segundos.

Boas práticas​

  • Um usuário de API por integração. Assim você revoga uma integração sem afetar as outras e identifica a origem das requisições.
  • Nunca exponha o token no navegador ou em aplicativos. Ele é uma credencial de servidor: use-o apenas no backend da sua integração.
  • Combine com IPs autorizados quando sua integração sai por IPs fixos, para que um token vazado não funcione fora da sua infraestrutura.
  • Regenere o token sempre que suspeitar de vazamento ou quando uma pessoa com acesso a ele deixar a equipe.