Utilização
Autenticação
O guia a seguir explicará como acessar a Bankspace para gerar credenciais de autenticação na API e como gerar um token de autenticação para utilização dos endpoints da API.
Siga o fluxo abaixo para acessar a Bankspace e gerar as credenciais de autenticação para a API.
Faça login no sistema da Bankspace, você pode acessa-lo clicando aqui.
Após autenticadado no sistema, expanda a aba de configurações presente na barra lateral.
Acesse 'API'
Já em 'API' é possível gerar uma nova credencial de integração clicando no botão de 'Cadastrar'.
Preencha o campo com o nome que deseja e clique em 'OK'.
Tendo cadastrado a API serão apresentados os dados de acesso a ela sendo, 'key' e 'secret'
:::caution
Salve estes dados em local seguro pois não será possível acessá-los novamente após clicar em ok.
:::
Agora que você já acessou a Bankspace e gerou novas credenciais de acesso à API, pode seguir para a autenticação na API e iniciar os testes das requisições.
Autenticação na API
A autenticação na API é realizada enviando no corpo da requisição a 'key' e o 'secret' gerado no painel de integrações da Bankspace. O retorno será um token que deve ser inserido no campo 'Authorization' das requisições, com o padrão Bearer. O token é um código único utilizado para autenticação e autorização na API, ele permite que o servidor identifique e valide o usuário que está fazendo a requisição.
Gerando um token de autenticação
:::highlight yellow 📌
Lembre-se de substituir os dados de exemplo pelos que você salvou quando gerou credenciais de autenticação para a API.
:::
Utilizando o token gerado
Como já citado anteriormente, o token que deve ser inserido no campo 'Authorization' das requisições, no exemplo a seguir o token foi utilizado para criação de um QRCode.
<Step title="Inserindo o token">
Preencha o campo destacado em vermelho com o token gerado anteriormente.
<Frame>
:::tip
O processo de utilização do token no envio de requisição nos demais endpoints será o mesmo.
:::