Autenticação



Para utilizar as nossas APIs e conseguir realizar operações, primeiramente você deve ter um usuário cadastrado na plataforma, com e-mail e senha.

Para criar um usuário verifique junto a área de negócios da sua empresa qual foi a URL que eles definiram junto ao time comercial aqui da Monkey.

APPs

Após o cadastro na plataforma, o usuário tem acesso ao menu Editar Perfil > Configuração de APIs (no canto superior direito da tela), onde é possível criar uma APP que será utilizada para autenticação e obtenção de tokens que irão permitir a comunicação com as nossas APIs.

Para criar uma APP é necessário apenas informar um nome para sua identificação e o sistema irá criar o seu client_secret e client_id

Token

Com essas informações, você irá realizar uma requisição para o nosso serviço de autenticação passando, além das informações de client_id e client_secret, o e-mail e senha utilizados para login do usuário que você cadastrou.

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:

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

Veja os detalhes da API aqui.

Refresh Token

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

Uma vez o Token expirado é possível realizar o “refresh” desse token.

Para isso você precisa fazer uma requisição onde são necessários apenas o client_id, client_secret e o refresh_token.

Veja os detalhes da API aqui.

Programa

Programa é o nome que damos para o portal de cada um dos nossos clientes.

Em muitos casos, uma empresa pode ser fornecedora do cliente A e do cliente B, dessa forma, ela pode participar tanto do programa A quanto do programa B.

Ao mesmo tempo uma instituição financeira pode financiar tantos fornecedores do cliente A, quanto do cliente B, assim ela também participará dos programas A e B.

Para que nós possamos identificar em qual programa você deseja realizar as operações, precisamos que você sempre envie um Header Program.

Importante: o usuário precisa estar habilitado no programa e caso seja usuários diferentes para cada programa é necessário fazer a requisição de um novo token. Exemplo de envio do header:

Program: EMPRESA

Listagem de Perfis

Após se cadastrar na plataforma você poderá gerenciar uma ou mais empresas. E a listagem dos seus perfis contém os links hypermedia para os recursos bases. Veja os detalhes aqui.