API Reference

É necessário passar as credenciais para que este endpoint retorne um token de acesso, todas as solicitações de API exigem que um token de acesso válido seja incluído como um header Authorization.

Segue o modelo do gerador de cabeçalho de autenticação básica (Basic Base64), é necessário enviar a solicitação no formato username:password. O padrão de preenchimento a ser seguido é clientID:clientSecret, como no exemplo:

Feito isso, também é necessário informar o tipo de concessão e escopo, como mostrado abaixo:

O retorno da requisição é o Token de acesso, seguindo o formato abaixo:


cURL: Pegar o encode gerado pelas credenciais e substituir no header Authorization no lugar de base64(clientID:clientSecret)

curl --location --request POST '<https://stage-onboarding-auth.pagaleve.io/oauth2/token>'  
--header 'Authorization: Basic base64(clientID:clientSecret)'  
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'grant_type=client_credentials'  
--data-urlencode 'scope=stage-onboarding/api'

Parâmetros de produção

URL: https://onboarding-auth.pagaleve.com.br/oauth2/token
Escopo: prod-onboarding/api


Parâmetros

  • grant_type: Espaço para informar as credenciais
  • scope: É necessário informar o escopo da requisição
  • access_token: Token válido necessário para fazer as demais requisições
  • expires_in: Tempo de expiração
  • token_type: Tipo do token