Fluxo de Dados de Diversidade para BI

🚧

Pré-Requisitos

A utilização da API de Diversidade da Gupy requer a presença e ativação do módulo de Diversidade e Inclusão pela empresa saiba mais.

Autenticação

Para utilizar este fluxo, é necessário utilizar o Bearer Token gerado nas configurações avançadas da plataforma. Acesse nossa seção de autenticação. Para saber como gerar o token de autenticação.

Abaixo encontra-se uma sugestão dos Endpoints que devem ser habilitados obrigatoriamente para o funcionamento perfeito deste fluxo.

Fluxo de integração

O endpoint /api/v2/applications-diversity na plataforma Gupy visa permitir o acesso e a extração de dados relacionados à diversidade dos candidatos em processos seletivos. Ao fazer uma requisição para este endpoint, você pode obter informações valiosas sobre os candidatos, status da candidatura, dados de diversidade (como deficiência, identidade de gênero, orientação sexual, raça/cor, entre outros), datas relevantes do processo seletivo e origens geográficas.

Este endpoint é essencial para empresas que buscam melhorar a gestão de seus processos de recrutamento e seleção, promovendo a inclusão em suas equipes. A resposta bem-sucedida deste endpoint fornece dados estruturados em formato JSON, permitindo uma integração eficiente e automatizada com sistemas externos.

Parâmetros de Consulta

A tabela abaixo descreve os parâmetros de consulta disponíveis ao fazer uma requisição para o endpoint /api/v2/applications-diversity.

Utilize o cURL ou ferramentas de desenvolvedor para fazer chamadas de teste à API.

curl --request GET \
     --url https://api.gupy.io/api/v2/applications-diversity \
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
     

Exemplo de Resposta

{
  "results": [
    {
      "anonymizedId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "jobId": 123,
      "currentStepId": 456,
      "status": "in_progress",
      "createdAt": "2023-12-04T12:00:00Z",
      "updatedAt": "2023-12-04T13:30:00Z",
      "hasDisabilities": true,
      "genderIdentity": "cisgender",
      "sexualOrientation": "heterosexual",
      "raceColor": "white",
      "cityOfOrigin": "CityName",
      "stateOfOrigin": "StateName",
      "birthDate": "1990-01-01T00:00:00Z"
    }
  ],
  "nextPageToken": "string"
}

Para mais informações sobre as respostas possíveis veja o Glossário de Dados

Erros Comuns e Soluções

Ao utilizar a API de Diversidade da Gupy, você pode encontrar alguns erros comuns. Abaixo estão alguns dos erros mais frequentes e sugestões de como lidar com eles:

1. Erro 401: Token de Autorização Inválido

Descrição: Este erro ocorre quando o token de autorização fornecido é inválido ou expirou.

{
  "title": "Unauthorized",
  "detail": "The token is malformed.",
  "status": 401
}

Solução: Certifique-se de que você está utilizando um token de autorização válido. Caso o token tenha expirado, regenere-o conforme as orientações na seção de autenticação e atualize-o em suas solicitações.

2. Erro 403: Acesso Negado

Descrição: Este erro indica que o usuário não tem permissão para acessar os dados deste endpoint.

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

Solução: Verifique se a conta associada ao token de autorização possui as permissões necessárias para acessar o endpoint. Caso necessário, entre em contato com o suporte da Gupy ou seu representante para ajustar as permissões.

Lembre-se de verificar a página de suporte da Gupy para obter assistência adicional ou entre em contato com o suporte técnico se encontrar problemas persistentes.