Como utilizar a API da Gupy: Primeiros passos

O que você encontra aqui: 

• Construções de integrações com a Gupy
• Primeiros passos
• O que é possível encontrar na API Pública e em nossos Webhooks
• Possibilidades de utilização 

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

Este artigo é primeiro de uma série explicativa sobre como utilizar a API pública da Gupy e realizar integrações com outros sistemas. Aqui falaremos sobre como a API funciona e quais são os primeiros passos para começar a utilizar. 

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

• Como utilizar a API da Gupy: Primeiros passos (você está aqui);
• Geração de Tokens: Como habilitar Token da API pública
• Como utilizar a API da Gupy: Operações disponíveis
• Como utilizar a API da Gupy: Webhooks

Construções de integrações com a Gupy

Hoje, todos os clientes da Gupy com os planos Premium ou Enterprise possuem o acesso à API Pública e aos Webhooks do nosso produto Recrutamento & Seleção.

A nossa API é disponibilizada no formato REST API, ou seja, em um padrão de mercado que utiliza protocolo HTTPS para infinitas possibilidades de integração entre diferentes sistemas.

Além da API, disponibilizamos também alguns Webhooks que possibilitam que outros sistemas sejam notificados sempre que determinado evento ocorre dentro da plataforma. A notificação é enviada através de um arquivo JSON enviado para a URL cadastrada na configuração do Webhook.

No geral, os clientes Gupy utilizam tais artefatos para integrarem a Gupy com sistemas de folha de pagamento, sistemas de benefícios, entre outros utilizados pela área de Recursos Humanos.

Esta série visa facilitar o entendimento da nossa API e dar alguns exemplos sobre como utilizá-la, mas o detalhamento completo de todas as funções pode ser encontrado em nossa documentação: https://developers.gupy.io/reference/introduction

Primeiros passos

Para começar a utilizar a API, é preciso entender como funciona a autenticação e como utilizar os tokens de acesso. 

A API da Gupy utiliza como padrão a seguinte URL: https://api.gupy.io/api/v1

Para a correta autenticação na API, utilizamos tokens de acesso do tipo Bearer (RFC 6750), conforme o exemplo abaixo:

O token pode ser gerado diretamente pela plataforma da sua empresa. Veja neste artigo como gerar: 

• Geração de Tokens: Como habilitar Token da API pública

O que é possível encontrar na API Pública e em nossos Webhooks

Há diferentes endpoints da Gupy que podem ser acessados através da API. Para isso, há também uma série de operações passíveis de serem executadas, sendo elas:

Dependendo do endpoint, operações diversas estarão disponíveis e diferentes informações podem ser encontradas em cada um deles. Nós recomendamos que a documentação seja continuamente consultada para que você entenda a fundo todas as características de cada ação. 

Outro ponto importante é que em muitos casos é possível aplicar filtros específicos. Por exemplo: na listagem de vagas (endpoint: [GET] Listing jobs) é possível filtrar por status e receber os dados somente de vagas que estão publicadas. 

Dentre os endpoints disponíveis, temos as seguintes possibilidades de utilização:

• Aplicações

Definimos como aplicação toda inscrição realizada em uma vaga existente dentro da plataforma de recrutamento e seleção. As ações passíveis de serem executadas a partir da API Pública estão listadas a seguir.

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