Fluxo de Criação e Atualização de Pessoas Usuárias

Gerando o token

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.

No momento de gerar o token habilite os seguintes endpoints da V1:

• Company Users

Criação dos perfis de acesso

A criação dos perfis de acesso é feita somente através da plataforma. Veja aqui neste guia como configurar um perfil de acesso.

Criando as pessoas usuárias

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

📘

Parâmetros opcionais

Apenas os dois primeiros são obrigatórios! O parâmetro filial é o único que gera uma limitação na gestão de vagas da pessoa usuária.

Caso seu perfil esteja habilitado para que ela só veja vagas de sua estrutura organizacional, ela deixará de ter visibilidade de vagas que não estejam dentro da estrutura em que foi inserida.

Exemplo de requisição

curl --request POST \
     --url https://api.gupy.io/api/v1/users \
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
     --header 'content-type: application/json' \
     --data '
{
     "branchIds": [
          9345
     ],
     "name": "Nome Sobrenome",
     "email": "[email protected]",
     "accessProfileId": 789,
     "code": "987"
}
'

Exemplo de resposta

{
  "accessProfileId": 789,
  "id": 12345,
  "departmentId": null,
  "roleId": null,
  "createdAt": "2023-02-24T20:20:16.019Z",
  "updatedAt": "2023-02-24T20:20:16.040Z",
  "name": "Nome Sobrenome",
  "email": "[email protected]",
  "profileTestEnabled": false,
  "type": null,
  "code": "987",
  "profileTestStatus": "not_selected",
  "testStatus": "uninvited",
  "taxpayerRegistry": null,
  "countryOfOrigin": Brazil
}

Buscando parâmetros na API

Para localizar accessProfileId:

1. Utilize o endpoint Listing user access profiles onde o parâmetro name = nome do perfil que foi criado na Gupy e que você deseja consultar o Id para atribuir ao novo usuário.
2. Armazene results.id para utilizá-lo no POST Users com *accessProfileId

Para localizar branchId:

1. Com o seu código de filial (id interno) utilize o GET Branches onde o parâmetro code = código da filial ou estrutura organizacional (id interno).
2. Armazene results.id para utilizá-lo no POST Users com *branchId

Atualizando as pessoas usuárias

1. Acesse o endpoint GET users
2. Preencha o "email" com o e-mail da pessoa usuária que precisa ter seu cadastro atualizado
3. Clique em "Try it!" e guarde a userId
4. Acesse o endpoint PUT users e preencha os parâmetros

Exemplo de requisição

curl --request PUT \
     --url https://api.gupy.io/api/v1/users/12345 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
     --header 'content-type: application/json' \
     --data '
{
     "branchIds": [
          9345
     ],
     "name": "Nome Sobrenome II",
     "email": "[email protected]",
     "accessProfileId": 789,
     "code": "987"
}
'

Exemplo de resposta

{
  "accessProfileId": 789,
  "id": 12345,
  "departmentId": null,
  "roleId": null,
  "createdAt": "2023-02-24T20:20:16.019Z",
  "updatedAt": "2023-02-24T20:20:16.040Z",
  "name": "Nome Sobrenome II",
  "email": "[email protected]",
  "profileTestEnabled": false,
  "type": null,
  "code": "987",
  "profileTestStatus": "not_selected",
  "testStatus": "uninvited",
  "taxpayerRegistry": null,
  "countryOfOrigin": Brazil
}

Removendo um usuário

1. Acesse o endpoint GET users
2. Preencha o "email" com o e-mail da pessoa usuária que precisa ter seu cadastro deletado
3. Clique em "Try it!" e guarde a userId
4. Acesse o endpoint DELETE users e preencha a userId

Exemplo de requisição

curl --request DELETE \
     --url https://api.gupy.io/api/v1/users/1234 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

Exemplo de resposta

OK

Como ficará essa integração na Gupy?