Obtendo Token

URL base da API:

https://api.recrutei.com.br

Para utilizar qualquer endpoint da API da Recrutei, deve-se obter um Bearer Token de acesso inicialmente.

Para isso, devem ser obtidas as seguintes informações:

Nome do campo	Onde Obter
x-api-key	Deve ser obtido acessando a conta de empresa da Recrutei, por um usuário com permissão de acesso em: "Configurações" > "API". Uma vez estando na página de API, o dado de token da empresa estará visível e disponível para utilização.
x-api-secret	Deve ser obtido acessando a conta de empresa da Recrutei, por um usuário com permissão de acesso em: "Configurações" > "API". Uma vez estando na página de API, o dado de token da empresa estará visível e disponível para utilização.

Com os dados em mãos, deve-se utilizá-los como HEADERS da requisição no endpoint abaixo de autenticação.

Endpoint de autenticação

Endpoint	Método	Link para Teste
/api/v1/login-api	POST	Clique aqui

Headers necessários

Nome	Valor	Descrição
x-api-key	string	Token key de identificação da empresa.
x-api-secret	string	Token secret de identificação da empresa.
Content-Type	application/json	Tipo de formato da requisição

Payload da requisição:

Nome	Valor	Descrição
email	email	Seu endereço de email ou endereço para o qual o token deve ser gerado
password	string	Senha do endereço de email enviado

Exemplo de Payload (JSON):

{
  "email": "[email protected]",
  "password": "teste123"
}

Uma vez que a requisição seja realizada com os dados corretos, você receberá o código 200, com uma response no formato abaixo:

{
  "message": "Ação realizada com sucesso!",
  "token": "eyJ0eXAiOiJKV1QiLCJhn345d....",
  "user": { /* ... dados do usuário ... */ },
  "manager": { /* ... dados do recrutador ... */ },
  "company": { /* ... dados da empresa ... */ },
  "token_type": "Bearer",
  "expires_in": 1296000,
  "scope": "manager-api"
}

O campo token é exatamente o bearer token necessário para utilizar em todas as requisições nos outros endpoints da API. Utilize-o como Header, conforme as indicações nos artigos dos endpoints que for utilizar.

Erros comuns

Caso seus dados de autenticação não estejam corretos, você receberá um código 401, com uma resposta no formato abaixo:

{
  "message": "Credenciais inválidas. Verifique o email e senha e tente novamente."
}

Para os casos em que, seus tokens de identificação da empresa não estejam corretos, ou, sua empresa esteja desativada na Recrutei, você receberá um código 401, com a resposta abaixo:

{
  "message": "API Key inválida ou empresa inativa."
}

Caso veja que seus dados de identificação da empresa estejam corretos, e ainda assim receber essa mensagem, entre em contato com [email protected] e detalhe a situação que poderemos te ajudar.