Autenticação

Todos os endpoints dessa API, com exceção dos listados na seção anonymous, requerem autenticação. A autenticação é feita através de um token JWT (JSON Web Token) que deve ser enviado no header Authorization de todas as requisições. Além disso, é necessário enviar o header X-Tenant em todas as requisições informando o identificador do cliente. Esse identificador é igual ao subdomínio do cliente na plataforma InHire. Ex: https://cliente.inhire.app -> cliente.

Como obter acesso

O owner da conta pode criar um novo service account em Configurações > Usuários de API > Adicionar Usuário. Isso gera um e-mail e uma senha de acesso à API do InHire, usados para obter o token de acesso descrito abaixo.

Obtendo um token de acesso

Para obter um token, é necessário fazer uma requisição POST para o endpoint https://auth.inhire.app/login com o email e senha do usuário. O token é retornado no corpo da resposta.

Requisição:

{
    "email": "{{email cadastrado no InHire}}",
    "password": "{{senha}}"
}

Resposta:

{
    "accessToken": "{{seu accessToken de curta duração}}",
    "refreshToken": "{{seu refreshToken para obter novos accessTokens sem precisar de
    um novo login}}"
}

aviso

Atenção: O token de acesso tem curta duração (1 hora) e o token de refresh tem duração de 30 dias. Após esse período, é necessário revalidar o token ou fazer um novo login para obter novos tokens.

Revalidando um token de acesso

Para revalidar um token de acesso, é necessário fazer uma requisição POST para o endpoint https://auth.inhire.app/refresh com o refreshToken retornado no login. O novo token de acesso é retornado no corpo da resposta.

Requisição:

{
    "refreshToken": "{{refreshToken originalmente retornado no login}}"
}

Resposta:

{
    "accessToken": "{{seu accessToken de curta duração}}",
    "refreshToken": "{{seu refreshToken para obter novos accessTokens sem precisar de
    um novo login}}"
}