Na Spike usamos o padrão OAuth2 para realizar a segurança das nossas APIs, o seu API Client atrelado a um usuário de integração poderá realizar as requisições para as APIs referentes ao seu perfil de acesso.

Para iniciar a utilização das APIs você primeiramente deve realizar o seu cadastro em nossa plataforma, para isso você irá precisar entender alguns pontos antes de iniciar o processo de cadastro.

Cada cliente dentro da Spike é separado em um conceito que chamamos de Programa. Os programas são segregados e você precisa realizar um cadastro em cada um dos programas que for participar.
Cada usuário dentro de um programa pode gerenciar um ou mais perfis, os perfis nada mais são do que cadastros de empresas. Existem três tipos de perfis dentro da nossa plataforma:

Sellers: São os estabelecimento comerciais que possuem recebíveis disponíveis para antecipar.

Buyers: São Instituições financeiras que estão interessadas em realizar a antecipação dos recebíveis dos estabelecimentos comerciais do programa.
A Spike conta com dois ambientes, o ambiente de Stagging que é utilizado para testes e o ambiente de Produção. Esses ambientes são segregados então os dados de um ambiente não são visíveis no outro.

Agora que os conceitos fundamentais foram esclarecidos vamos obter o token:

Obtendo o Token de Autenticação

Após a criação do seu Usuário e do seu Client de API você conseguirá obter o token de autenticação, ele é necessário para todas as chamadas de API.

Para conseguir o token de autenticação você deve realizar uma requisição da seguinte forma:

Headers:

Content-Type: application/x-www-form-urlencoded

Propriedades:

client_id: Seu Client Id
client_secret: Seu Client Secret
username: Email do Usuário Cadastrado na Plataforma
password: Senha do Usuário Cadastrado na Plataforma
grant_type: Valor Fixo, Sempre Enviar o Valor: password
scope: Valor Fixo, Sempre Enviar o Valor: server

Caso a operação seja realizada com sucesso, você receberá um retorno que irá conter o seu token (access_token), que deverá, por sua vez, ser enviado em todas as requisições transmitidas para a plataforma.

Veja o exemplo no Payload de retorno abaixo:

{
  "access_token": "8bf8047e-eb30-45cb-9145-73c759f2a594",
  "token_type": "bearer",
  "refresh_token": "ed6f1cca-2d0f-4341-b7d1-82f9a21171d7",
  "expires_in": 430507,
  "scope": "api"
}

Veja como deve ser o header enviado em todas as requisições utilizando o access_token retornado:

Authorization: Bearer 8bf8047e-eb30-45cb-9145-73c759f2a594

Veja os detalhes da API aqui.

Realizando o Refresh do Token de Autenticação

Como visto acima na obtenção do Token, o mesmo possui um tempo de expiração.

Uma vez que o Token expirou, é possível realizar o "refresh" desse token.

Para conseguir um novo token de autenticação você deve realizar uma requisição da seguinte forma: