Obter Tokens de Acesso

Para acessar os recursos de um usuário com o prévio consentimento dele pelo Guiabolso Connect você precisará do código de autorização dele. Do passo anterior, lembre-se de que enviamos esse código ou pela URL de callback ou pelo listener de evento criado para a janela Modal.

O código de autorização é válido por 60 minutos e isso significa que você tem apenas 60 minutos para pedir autorização para nossa API em nome do usuário usando esse código.

Como chamar a API pra obter os Tokens?

Envie um POST request para https://kasbah.guiabolso.com.br para a rota /partner/events/

COPIAR

{
  "name": "oauth:tokens:exchange",
  "version": 1,
  "id": "0845bb8b-24e6-4741-9436-d15076906371",
  "flowId": "fd9a2041-febf-44fe-a576-39bae907c5a2",
  "payload": {
    "code": "AUTH_CODE"
  },
  "identity": {
    "clientId": "CLIENT_ID"
  },
  "auth": {
    "clientSecret": "CLIENT_SECRET"
  },
  "metadata": {}
}

Campo	Descrição
`id`	É um identificador único, pode ser um UUID gerado de forma aleatória, que identifica esse evento específico. Você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`flowId`	É um identificador único, pode ser um UUID gerado de forma aleatória. Diz respeito a como o Guiabolso rastreia as requisições dentro da sua plataforma, você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`code`	Código de autorização do usuário recebido via callback ou modal e passado aqui em formato string
`clientId`	ID da sua chave de API que fornecemos pra você
`clientSecret`	Secret da sua chave de API que fornecemos pra você

Exemplo de uma resposta bem sucedida, note os 2 tokens retornados dentro de payload.

COPIAR

{
  "name": "oauth:tokens:exchange:response",
  "version": 1,
  "id": "0845bb8b-24e6-4741-9436-d15076906371",
  "flowId": "fd9a2041-febf-44fe-a576-39bae907c5a2",
  "auth": {},
  "identity": {},
  "payload": {
    "accessToken": "ACCESS_TOKEN",
    "refreshToken": "REFRESH_TOKEN"
  },
  "metadata": {}
}

E se o Token de Acesso tiver Expirado?

O token de acesso tem a expiração de apenas 30 minutos, isso quer dizer que você tem 30 minutos pra usá-lo. Se o token tiver expirado você pode gerar um outro token de acesso contanto que tenha o token de atualização.

Envie um POST request para https://kasbah.guiabolso.com.br para a rota /partner/events/

COPIAR

{
  "name": "oauth:refresh:token:exchange",
  "version": 1,
  "id": "3c254fec-f494-4347-a8cf-4b5e817a62e6",
  "flowId": "d72893f7-6b4c-4ba5-acff-f0bf78414dbe",
  "payload": {
    "refreshToken": "REFRESH_TOKEN"
  },
  "identity": {
    "clientId": "CLIENT_ID"
  },
  "auth": {
    "clientSecret": "CLIENT_SECRET"
  },
  "metadata": {}
}

Exemplo de uma resposta bem sucedida, note o novo token é retornado dentro de payload. O token de atualização é válido por 1 dia inteiro a não ser que seja um usuário do Guiabolso, aí o token de atualização é válido durante 90 dias. Isso quer dizer que dentro de 24 horas você poderá obter as mesmas informações financeiras do usuário, elas estarão disponíveis na nossa API.

COPIAR

{
  "name": "oauth:refresh:token:exchange:response",
  "version": 1,
  "id": "3c254fec-f494-4347-a8cf-4b5e817a62e6",
  "flowId": "d72893f7-6b4c-4ba5-acff-f0bf78414dbe",
  "payload": {
    "accessToken": "ACCESS_TOKEN"
  },
  "identity": {},
  "auth": {},
  "metadata": {}
}

E o Middleware como ajuda?

Nós criamos um Middleware pra ajudar na integração e fazer o mapeamento dos tokens pra você, se você quiser saber mais detalhes sobre os benefícios de usar o Guiabolso Connector basta seguir e ler as próximas seções. Mas note que o Middleware deve ser instalado na sua infraestrutura de Cloud (hoje suportamos tanto a AWS quanto o GCP).

Envie um POST request para o Connector para a rota /partner/events/ passando o código de autorização e o próprio Connector já vai gerenciar pra você se o token de acesso tiver expirado.

COPIAR

{
  "name": "authorization:code",
  "version": 1,
  "id": "0845bb8b-24e6-4741-9436-d15076906371",
  "flowId": "fd9a2041-febf-44fe-a576-39bae907c5a2",
  "payload": {
    "authorizationCode": "AUTH_CODE"
  },
  "identity": {
    "userId": "USER_ID"
  },
  "metadata": {},
  "auth": {}
}

Campo	Descrição
`id`	É um identificador único, pode ser um UUID gerado de forma aleatória, que identifica esse evento específico. Você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`flowId`	É um identificador único, pode ser um UUID gerado de forma aleatória. Diz respeito a como o Guiabolso rastreia as requisições dentro da sua plataforma, você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`authorizationCode`	Código de autorização do usuário recebido via callback ou modal e passado aqui em formato string
`userId`	ID do seu usuário na sua plataforma em formato string

Note que no Connector é necessário informar um ID de usuário da sua plataforma, e o próprio Connector já vai gerenciar pra você os mapeamentos. Ele também já terá configurado o seu acesso e suas chaves de API de maneira segura e criptografada, e portanto você não precisar se preocupar com esses dados sendo trafegados dentro da sua infraestrutura de maneira indevida.

Exemplo de uma resposta bem sucedida, note que os tokens não foram retornados na resposta porque o Connector os armazena num banco de dados e gerencia toda a troca de tokens e atualização dos tokens expirados para você.

COPIAR

{
  "name": "authorization:code:response",
  "version": 1,
  "id": "0845bb8b-24e6-4741-9436-d15076906371",
  "flowId": "fd9a2041-febf-44fe-a576-39bae907c5a2",
  "payload": {},
  "identity": {},
  "auth": {},
  "metadata": {}
}

1. Abrir a Experiência

3. Buscar Dados