Autorização
Concessão de token de acesso
A autorização para o consumo da API é concedida através de um token de acesso no padrão OAuth 2.0 [RFC6749].
Para gerar o token, cada parceiro deve possuir suas próprias credenciais: Client ID e Client Secret
Essas credenciais devem ser solicitadas à Porto Seguro através da criação de uma APP no Portal do Desenvolvedor.
ATENÇÃO: ANOTE E PROTEJA AS CREDENCIAIS DA SUA APP ASSIM QUE FOR CRIADA!
A concessão de token a partir dessas credenciais só estará disponível após aprovação da Porto Seguro
NOTA: Essas credenciais são de uso exclusivo para os ambientes inclusos nos planos de consumo das APIs selecionadas. O ambiente padrão é sempre o de sandbox, podendo o parceiro solicitar acesso aos demais ambientes, mediante assinatura de acordo com a Porto Seguro.
Teste aqui a API de autorização em ambiente sandbox.
Boas práticas no uso da API de autorização
A API de autorização concede tokens de acesso com validade de uma hora (3600 s).
O token deve ser gerado uma única vez NESSE PERÍODO e todas as requisições para a API devem ser efetuadas enviando um mesmo token de acesso.
Recomenda-se a implementação de cache do lado da aplicação para armazenamento do token durante o seu período de vigência. Deve-se assegurar a confidencialidade do token durante todo esse período.
Efetuando chamada a API de autorização
Request:
curl --location --request POST 'https://portoapi-hml.portoseguro.com.br/oauth/v2/access-token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic [client_id:client_secret em BASE64]' \
--data-urlencode 'grant_type=client_credentials'
Response:
{
"access_token": "YmFhZWU4MzEfhtOThjNy0zYWY5LWJmZjEtOWQwYWQzY2JmNjYxOjcwMTE4YmQxLWE1ZDItMzIyMy1hYzRmLTY5M2VlYjE5NGNiMQ==",
"token_type": "Bearer",
"expires_in": 3600
}
O conteúdo a ser utilizado para consumo das APIs é o valor do campo "access_token".
ATENÇÃO: Ficar atento ao host. Neste exemplo estamos utilizando o host de homologação, o qual deve ser substituído de acordo com o ambiente que se deseja acessar (se contemplado no plano de consumo).