Fluxo de Criação e Atualização de Áreas

📘

Sobre as áreas

Na Gupy, utilizamos o nome "áreas" na interface e departments na API. Eles se referem ao mesmo campo.

❗️

Atenção!

A API não permite a exclusão de áreas que estejam sendo utilizadas em vagas ou usuários. Essa exclusão só é possível caso não haja vagas ou usuários atrelados.

Atualizações de área podem ser feitas em massa via suporte. Entre em contato com a pessoa responsável pela sua conta para entender como fazer isso.

Habilitando Endpoints

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 o token de autenticação.

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

Criando as áreas

Acesse o endpoint POST Departments e preencha os parâmetros:

Exemplo de requisição

curl --request POST \
     --url https://api.gupy.io/api/v1/departments \
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
     --header 'content-type: application/json' \
     --data '
{
     "name": "Gente e Gestão",
     "similarTo": "human_resources",
     "code": "12"
}
'

Exemplo de resposta

{
  "id": 1234,
  "name": "Gente e Gestão",
  "code": "12",
  "similarTo": "human_resources",
  "createdAt": "2023-02-24T19:35:16.608Z",
  "updatedAt": "2023-02-24T19:35:16.608Z"
}

Atualizando as áreas

1. Acesse o endpoint GET Departments
2. Filtre pela área que deseja atualizar através dos campos "name" ou "code"
3. Clique em "Try it!" e salve a departmentId
4. Acesse o endpoint PUT Departments e preencha os parâmetros:

Exemplo de requisição

curl --request PUT \
     --url https://api.gupy.io/api/v1/departments?name=gente&perPage=10&page=1'\
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
     --header 'content-type: application/json' \
     --data '
{
     "code": "12",
     "name": "Recursos Humanos"
}
'

Exemplo de resposta

{
  "id": 1234,
  "name": "Recursos Humanos",
  "code": 12,
  "similarTo": "human_resources",
  "createdAt": "2020-07-14T17:37:24.402Z",
  "updatedAt": "2023-02-24T19:43:44.658Z"
}

Como ficará essa integração na Gupy?

Possíveis erros

Áreas diferentes com mesmo código

É comum que áreas com o mesmo nome possuam códigos diferentes e, nossa sugestão para esse cenário é utilizar o nome das áreas de uma forma “concatenada”, como por exemplo: ID + Nome da Área.