Como utilizar a API da Gupy: Operações disponíveis

O que você encontra aqui: 

• Páginas de carreira
• Áreas da empresa
• Cargos da empresa
• Campos customizados de vagas
• Templates de vagas
• Templates de e-mail 
• Vagas
• Usuários
• Filiais e estrutura organizacional

--------------------------------------------------------------------------------------------------------------------

Este artigo faz parte de uma série explicativa sobre como utilizar a API pública da Gupy e realizar integrações com outros sistemas. Aqui falaremos sobre algumas das operações disponíveis e as partes da plataforma em que elas se aplicam. 

Se você quiser acompanhar os outros artigos da série, acesse:

• Como utilizar a API da Gupy: Primeiros passos;
• Como utilizar a API da Gupy: Operações disponíveis(você está aqui); 
• Como utilizar a API da Gupy: Webhooks; 

Páginas de carreira 

Páginas de carreira são as páginas públicas dos clientes da Gupy em que listamos todas as vagas publicadas para que as pessoas candidatas possam se aplicar.

Documentação: https://developers.gupy.io/reference/company-career-pages

 

Operações	Resultado
[GET] Listing career pages	Retorna todas as páginas de carreira existentes na empresa

 

Áreas da empresa

O cadastro de áreas da empresa é importante para que possamos associar usuários e vagas às áreas corretas. Além disso, tal dado poderá ser também válido para análises subsequentes de indicadores de desempenho dos processos.

Documentação: https://developers.gupy.io/reference/company-departments

 

Operações	Resultados
[GET] Listing departments	Retorna todas as áreas da empresa cadastradas na plataforma
[POST] Creating a department	Viabiliza a criação de uma nova área na Gupy
[PUT] Updating a department	Atualiza as informações de uma área existente na Gupy

 

Cargos da empresa

O cadastro de cargos da empresa é importante para que possamos associar usuários e vagas aos cargos corretos. Além disso, tal dado poderá ser também válido para análises subsequentes de indicadores de desempenho dos processos.

Documentação: https://developers.gupy.io/reference/job-roles

 

Operações	Resultados
[GET] Listing roles	Retorna todos os cargos da empresa cadastradas na plataforma
[POST] Creating a role	Viabiliza a criação de um novo cargo na Gupy
[PUT] Updating a role	Atualiza as informações de um cargo existente na Gupy

 

Campos customizados de vagas

Campos customizados é uma feature que possibilita que a empresa cadastre campos específicos para a criação da vaga que ficarão disponíveis na área de “dados internos”.

Documentação: https://developers.gupy.io/reference/job-custom-fields

 

Operações	Resultado
[GET] Listing custom fields of a company for job creation	Retorna os campos customizados criados para as vagas da empresa

 

Templates de vagas

Templates de vagas são utilizados para facilitar e padronizar a criação de vagas dentro da plataforma Gupy.

Documentação: https://developers.gupy.io/reference/job-templates

 

Operações	Resultado
[GET] Listing custom fields of a job template	Retorna os campos customizados existentes em um template de vaga específico
[GET] Listing job templates	Retorna os templates de vagas existentes na empresa

 

Templates de e-mail

Para facilitar e padronizar a comunicação na Gupy, é possível utilizar templates de e-mails em nosso produto. O endpoint é responsável por apresentar os templates existentes.

Documentação: https://developers.gupy.io/reference/e-mail-templates

 

Operações	Resultados
[GET] Listing e-mail templates	Retorna os templates de e-mail cadastrados na Gupy

Vagas

Para que tenhamos contratações dentro da Gupy, é necessário que a empresa crie e publique vagas de acordo com as posições que demandam por contratação. Tal endpoint visa possibilitar as principais ações vinculadas a criação, publicação e gestão de vagas na Gupy.

Documentação: https://developers.gupy.io/reference/jobs

 

Operações	Resultados
[POST] Creating a job	Viabiliza a criação de uma nova vaga
[GET] Listing jobs	Lista as vagas existentes em uma empresa
[GET] Listing custom fields of a job	Lista os campos customizados específicos de uma vaga
[GET] Listing steps of a job	Lista quais são as etapas programadas em uma vaga existente na Gupy
[PATCH] Updating a job	Possibilita que determinados dados de uma vaga sejam atualizados a partir da API
[DELETE] Deleting a draft job	Vagas que ainda estão como rascunho, ou seja, não foram publicadas podem ser deletadas a partir da API Pública
[POST] Creating a classifier	Adiciona um qualificador para uma vaga existente
[GET] List job classifiers	Retorna quais são os qualificadores cadastrados em uma vaga existente
[POST] Creating a vacancy code	Adiciona um código de posição para uma vaga
[GET] Listing vacancy codes	Lista quais são os códigos de posição existentes em uma vaga
[DELETE] Deleting a vacancy code	Viabiliza a deleção de um código de posição
[PUT] Updating a vacancy code	Viabiliza a atualização de um código de posição

 

Usuários

O endpoint viabiliza a gestão de usuários dentro da Gupy, sendo possível criar, listar e excluir usuários, além da possibilidade de identificar os perfis de acesso.

Documentação: https://developers.gupy.io/reference/company-users

 

Operações	Resultados
[GET] Listing user access profiles	Retorna quais são os perfis de acesso cadastrados na plataforma
[POST] Creating an user	Possibilita a criação de um usuário da plataforma. É importante que a operação seja utilizada em conjunto com [POST] Invinting an user para assegurar que o usuário irá receber o convite para ingressar na plataforma
[GET] Listing users	Retorna os usuários existentes na plataforma
[PUT] Updating an user	Atualiza informações de usuários cadastrados
[DELETE] Deleting an user	Viabiliza a desativação de usuários que não deverão mais acessar a plataforma
[POST] Inviting an user	Encaminha o e-mail convite para um usuário ingressar na plataforma

 

Filiais e estrutura organizacional

O cadastro de filiais ou estrutura organizacional é importante para que possamos associar usuários e vagas às estruturas corretas. Além disso, tal dado poderá ser também válido para análises subsequentes de indicadores de desempenho dos processos.

Documentação: https://developers.gupy.io/reference/company-branches

 

Operações	Resultados
[POST] Creating branches	Possibilita a criação de filiais ou estruturas
[GET] Listing branches	Retorna as filiais ou estruturas existentes na plataforma
[DELETE] Deleting a branch	Viabiliza que uma filial ou estrutura específica sejam removidos da plataforma
[PUT] Updating branch	Atualiza as informações de uma estrutura ou filial existente na Gupy