Acesso e Autenticação
Nossas APIs usam autenticação utilizando o protocolo Auth 2.0 que é especificado na RFC 6749. Para iniciar o desenvolvimento é necessário que você tenha em mãos as credenciais de acesso.
Detalhes da API de autorização
Cada aplicativo na sua organização está associado a uma combinação de ID do Cliente (client_id) com Chave Secreta (client_secret), chamadas de credenciais da API. Para receber as credenciais de acesso da sua aplicação você precisa dos seguintes dados:
Dados para Autorização |
---|
Nome completo do solicitante |
CPF do solicitante |
Razão Social |
CNPJ |
Telefone |
Envie um email para [email protected] com os dados acima para liberação do seu acesso.
As credenciais da API servem para os seguintes fins:
- Identificar o aplicativo que está chamando as APIs;
- Autorizar o acesso às APIs habilitadas na organização.
Como a API de autorização funciona
Depois que você obter as credenciais no Portal do Desenvolvedor, o endpoint do OAuth é usado para obter o token de acesso que serve como credencial para cada execução da API.
Os parâmetros obrigatórios para a solicitação OAuth são:
grant_type
: tipo de concessão. (Valor válido: client_credentials);client_id
: id da chave do aplicativo;client_secret
: chave secreta do aplicativo;scope
: escopo de acesso (Valor válido: openid).
O resultado dessa solicitação deve ser a seguinte:
access_token
: o token OAuth criptografado a ser usado na execução da API;token_type
: tipo de token .(Valor válido: Bearer);expires_in
: o tempo de expiração do token em milissegundos;scope
: escopo de autorização fornecida ao cliente.
Exemplos
Solicitação:
`
POST /oauth/token HTTP/1.1
Host: api-sandbox.opea.link
grant_type=client_credentials&client_id=YOUR_APPLICATION_KEY_ID&client_secret=YOUR_SECRET&scope=openid
Resposta:
{
access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX...,
token_type: bearer,
expires_in: 3600,
scope: openid
}
Nota: o token de acesso expira em 60 minutos.
Updated 3 months ago