Autenticação Recrutamento & Seleção

Para utilizar as APIs é necessário obter o Bearer Token gerado nas configurações avançadas da plataforma a partir do menu de SETUP > Configurações Avançadas > Geração de Tokens > Gerar Token. É necessário que a pessoa tenha perfil de acesso master ou administrador na plataforma da Gupy e que o perfil tenha a permissão de Gerenciar Tokens de API Pública, como mostra a figura abaixo:

Caso você ainda não esteja visualizando a opção de criar um token dentro do setup da sua empresa, contate o nosso suporte pelo site: https://suporte.gupy.io/s/suporte/.

A criação do token envolve atribuir as permissões aos endpoints que serão utilizados de acordo com a integração a ser desenvolvida. Exemplo: Se o fluxo envolve consultar, inserir e deletar TAGs é necessário habilitar a permissão aos endpoints correspondentes:

Caso você tenha dúvida de quais endpoints são necessários para sua integração, consulte nossos fluxos de negócio clicando aqui e veja qual atende à sua necessidade.

🚧

Endpoints que necessitam de todas permissões ativadas

Caso você precise do token para realizar consultas na API v2 de jobs ou roteiro de entrevistas, no momento da criação será necessário habilitar todos endpoints tanto para a v1 quanto para a v2. O token também deve ser gerado por uma pessoa com o perfil administrador. O mesmo ocorre para consumo do endpoint find hiring information.

Na prática:

Com o token em mãos é possível utilizar nossas APIs passando o Authorizationnos headers da requisição conforme o exemplo abaixo:

GET /api/v1/jobs
Host: api.gupy.io
Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Dúvidas Frequentes:

O token expira e preciso de um token de atualização?

Não. Nossas APIs de R&S utilizam tokens Bearer que não expiram.

Posso usar a API diretamente pelo navegador usando Javascript?

Nós não recomendamos isso. Você pode enfrentar problemas de CORS e expor seu token de acesso. Sempre faça chamadas para nossa API em seu backend.

Em vez de consultar os dados na API, preciso que você me envie os dados.

Consulte a seção Webhooks de nossa referência de API. Esta é a melhor solução se você precisar receber dados passivamente.

Estou utilizando o token que gerei na plataforma e recebo o seguinte erro:

{  
"title": "Forbidden", "detail": "No company is associated to the token provided. Please check the token value or contact your Gupy representative.", "status": 403  
}

Esse erro ocorre devido à falta de permissão do token gerado para realizar a ação desejada, para isso deve-se revisitar os endpoints que foram habilitados no momento da geração do token e se atentar às regras da seção "Endpoints que necessitam de todas permissões ativadas" explicadas nesse documento.

Documentações Auxiliares

Recomendamos a leitura das documentações complementares a seguir:

Veja aqui nesse guia como gerar seu token. ou acesse essa página para saber mais sobre autenticação.