Autenticação

Nessa seção iremos abordar o método de autenticação para integrações com Gupy Clima e Engajamento.

Antes de iniciar uma integração será necessário gerar seu token para consumir nossas APIs Públicas:

  • API Token Gestão de Colaboradores e Grupos: Gerar um token de API em configurações da conta
  • API Token Consulta de Score: Devido as políticas de privacidade, o colaborador que tiver acesso a esse token, terá também o acesso aos resultados de toda a empresa e todas as pesquisas. Sendo assim, apenas o admin da conta deve solicitar via e-mail, sem nenhum outro colaborador em cópia, para [email protected], o API Token, e o próprio admin da conta será responsável pelo compartilhamento interno do API Token para os colaboradores envolvidos.

Onde encontro o API Token?

Para a construção da integração de gestão de colaboradores e grupos, será necessário obter um token, disponível apenas para clientes com contrato ativo. Para acessar o token, siga o passo a passo abaixo:

  1. Faça o login na Gupy e escolha o produto Clima e Engajamento.

  2. Clique no ícone da engrenagem no canto superior direito da tela;

  3. No menu lateral, clique em CONFIGURAÇÕES;

  4. Em API, clique em Gerar Token;

Como se autenticar?

Para autenticar suas requisições de API, deve ser passado no header da requisição, o parâmetro Authorization, contendo o API Token da conta.

Exemplo de Requisição HTTP GET que retorna todos os colaboradores cadastrados

curl -X GET --header 'Accept: application/json' --header 'Authorization: [token]' 'https://www.pulses.com.br/api/engage/v1/employees/'