Autorização

Implementamos o padrão OAuth 2.0 para que você possa se comunicar com nossas APIs por meio de um único token do tipo Bearer.

Usando o token

Após receber o token de acesso, você deverá incluí-lo como header de autorização toda vez que se comunicar com nossas APIs.

Exemplo em Curl:

curl https://api.pomelo.la -H 'Authorization: Bearer eyJhbGciOiJSUzI1Ni'

Cada API validará o token de acesso e verificará se o escopo corresponde às permissões necessárias.

Para que as solicitações sejam válidas, você deverá se comunicar com nossas APIs apenas via HTTPS e incluir o header de autorização, indicando que é do tipo Bearer.

Solicitar Token

O endpoint /oauth/token é utilizado para obtenção do token de acesso. Ao realizar uma autenticação bem sucedida, salve-a, pois você precisará dela para se comunicar com nossas APIs.

Cada token é um JWT contendo um prazo de validade. Cada vez que você solicitar um token, enviaremos o mesmo até que ele expire. Assim que ele expirar, enviaremos um novo para você.

Parâmetros disponíveis
Header Parameters
content-typestringrequired
Enum: application/json
Body Parameters
client_idstringrequired
client_secretstringrequired
audiencestringrequired
Audiencia de API
grant_typestringrequired
Enum: client_credentials
Detalhe de respostas
access_tokenstring
Exemplo: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IloyTmZOUTQwWVVrNXh0WnNRRDlHYSJ9.eyJodHRwczovL3BvbWVsby5sYS9jbGllbnRfaWQiOiIyZmYxMjM0MTY3MzRmMjI5MmUxMTE0ODdiZWRlZmMxZTI1NDkxY2E4YzI1ZTEyMjAzM2E5MGE3NjM2ZDllNDI0IiwiaXNzIjoiaHR0cHM6Ly9wb21lbG8tZGV2ZWxvcC51cy5hdXRoMC5jb20vIiwic3ViIjoiMWNxdXBVM0U0bFpIY2U2ZFdVbHpuU29nZU1rR3ozelFAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vYXV0aC1kZXYucG9tZWxvLmxhIiwiaWF0IjoxNjMxMDM1MDQzLCJleHAiOjE2MzExMjE0NDMsImF6cCI6IjFjcXVwVTNFNGxaSGNlNmRXVWx6blNvZ2VNa0d6M3pRIiwic2NvcGUiOiJhcmc6Y2FyZHM6Z2V0LWNhcmQgYXJnOmNhcmRzOmdldC11c2VyLWNhcmQgYXJnOmNhcmRzOmNyZWF0ZS1iYXRjaCBhcmc6Y2FyZHM6YWN0aXZhdGUtY2FyZCBhcmc6Y2FyZHM6Y3JlYXRlLWNhcmQgYXJnOmNhcmRzOmNyZWF0ZS1jYXJkIGFyZzpjYXJkczp1cGRhdGUtYnVsay1jYXJkcyBhcmc6Y2FyZHM6c2VhcmNoLWNhcmQgYXJnOnVzZXJzOmdldC11c2VyIGFyZzp1c2VyczpjcmVhdGUtdXNlciBhcmc6dXNlcnM6c2VhcmNoLXVzZXIgYXJnOnVzZXJzOnVwZGF0ZS11c2VyIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.DkNi4BtLVdq1YMN5UFrtqvm2p-3DExt1X90janSfRWLbZHo2dtPtXkGfRF9kpdD3ZDA98euB68pt5nxZAGThaqm5g59pKkRz0nFzsDGUCH-Mfd6vYKGksO-dlyTeOwHyF189zYSvOMHcdaEOY2QybCWheOQnUgpFB7WaIPk6M8ZWI9SHSPtUjt6ePY7jsvDmVTtpXQM3ttB-0OarKN0qPi-A7WeD13Q7FuZHgQBxMipMlxeOfsz-RDOMwX7zTBhVNFp-Eu1Jtx1vFHVhDbG7tDW5N2np7kZvYXS5-wSP-fZMc57I1NmXrjbCACMWFhsnqTuHRJiHn3l-kG6nb7_EIw
scopestring
Exemplo: arg:cards:get-card arg:cards:get-user-card
expires_ininteger
Exemplo: 86400
token_typestring
Exemplo: Bearer

Esta seção foi útil para você?

POST/oauth/token
{
"client_id":
"3LBFuOiEHrl4BailkRlsnIMmSctMLb7A"
"client_secret":
"s5u3oYK0-A9CV6TkszPQThUa_qxMfr2yyd3-eJwQ ..."
"audience":
"https://auth-dev.pomelo.la"
"grant_type":
"client_credentials"
}
Respostas de amostra
{
"access_token":
"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtp ..."
"scope":
"arg:cards:get-card arg:cards:get-user-ca ..."
"expires_in":
86400
"token_type":
"Bearer"
}

Revogar token

O endpoint /oauth/token/revoke é usado para suspender um token de acesso do nosso cache. Ao revogar o token, você poderá solicitar um novo com o endpoint /oauth/token

Parâmetros disponíveis
Header Parameters
content-typestringrequired
Enum: application/json
Body Parameters
client_idstringrequired
client_secretstringrequired
audiencestringrequired
Audiencia de API
grant_typestringrequired
Enum: client_credentials
Detalhe de respostas
statusstring
Enum: SuccessError

Esta seção foi útil para você?

POST/oauth/token/revoke
{
"client_id":
"3LBFuOiEHrl4BailkRlsnIMmSctMLb7A"
"client_secret":
"s5u3oYK0-A9CV6TkszPQThUa_qxMfr2yyd3-eJwQ ..."
"audience":
"https://auth-dev.pomelo.la"
"grant_type":
"client_credentials"
}
Respostas de amostra
{
"status":
"Success"
}