Skip to main content

​
Fluxo de autenticação

1

Obtenha suas credenciais

Crie suas credenciais na Plataforma do RH ou solicite para sua gerente de contas. Assim que a credencial é criada, você recebe um par de chaves: seu Client ID e um Client Secret. O Client Secret é mostrado somente uma vez, no momento da criação, então guarde em um local seguro. Caso perca o Client Secret, você poderá atualizar ou gerar um novo par.
2

Autentique-se com POST /v1/authenticate

A aplicação cliente faz o login no endpoint POST /v1/authenticate usando o par de chaves obtido no passo anterior.
3

Use o access-token nas chamadas

A resposta da requisição de autenticação contém o campo access-token. Esse é o token Bearer que a aplicação deve enviar no cabeçalho HTTP Authorization de toda chamada aos endpoints que exigem autenticação.

​
Requisição

Envie o client-id e o client-secret no corpo da requisição, em JSON.
Em Homologação, use a base URL https://api.pipo.health.

​
Resposta

Autenticação bem sucedida (200 OK)
200 OK

​
Usando o token nas demais chamadas

Envie o access-token no cabeçalho Authorization, prefixado por Bearer:

​
Erros

Se o par client-id + client-secret for inválido, a API retorna 403 Forbidden com o erro invalid-client:
403 Forbidden
Confira se está usando as credenciais do ambiente correto (Produção ou Homologação) e se o par Client ID + Client Secret foi copiado sem espaços extras.