Passos principais

Para autenticação usamos o protocolo OAuth 2.0, mais precisamente o fluxo de autorização, para poder usar autenticações e buscar informações a partir da nossa plataforma você precisa seguir os passos listados abaixo.

🚧

IMPORTANTE!

Caso não cumpra estes passos não poderá acessar às funcionalidades da API.

Passos

Diagrama

1445

Passo 1: Criação da aplicação;
O primeiro passo é criar uma aplicação (pode ser feita a partir da URI de aplicações) com um ou mais escopos válidos e uma URI válida (HTTPS). Esta pode ser solicitada ao comercial do Credere, que será encarregado de gerar as informações da mesma a partir de um usuário válido.

Após a criação da aplicação serão geradas as seguintes informações:

  • Client_id.
  • Client_secret.
  • Scope.

Mantenha essas variáveis protegidas da mesma maneira que você protege suas senhas, essas informações serão utilizadas nos passos seguintes.

Passo 2: Gerar código para liberar o token;
Este código será usado para criar o token de autorização (passo 3), correspondente à primeira requisição obrigatória "Gerar token", que por sua vez da acesso aos recursos da API.

Gere o seu código usando o link:

ParâmetroObrigatórioDescrição
{redirect_uri}SimURI para qual ocorrerá o redirecionamento com o código de garantia de acesso
{client_id}SimId (UID) gerado na criação da aplicação
{scope}SimEscopos qual a aplicação poderá acessar os recursos

Ao abrir o link, iremos listar as informações quais o scope requisitado fornece acesso dentro da aplicação do Credere e o usuário precisa aceitar esses acessos para criação do código de garantia de autorização.

Após o usuário aceitar os termos, o código necessário será gerado no link da própria página. Esse código pode ser usado uma única vez, tem 5 minutos de validade e vai ser obrigatório para Gerar o Token da aplicação.
Passo 3:Primeira requisição

Aqui é onde vamos gerar o token da aplicação. Após receber o código de garantia de autorização (code) você deve usa-lo para criar um novo token de acesso na URL de criação de token. Após esse passo, você pode usar o token de acesso (access_token) gerado para acessar todos os recursos disponíveis para qual o scope do seu token possuí acesso.

Passo 4: Uso dos recursos

Uma vez gerado o access_token no passo 3, esse token pode ser usado para obter acesso aos recursos na API. O token tem validade de 6 meses, e quando tiver expirado ele pode ser gerado novamente seguindo os passos anteriores. Você deve enviar o token em todas requisições no cabeçalho da requisição Authorization com o valor Bearer[access_token].

📘

Aqui vai poder encontrar uma explicação ainda mais detalhada 👇🏼

Passo-a-passo: Como se autenticar na API do Credere