Autenticação

Na Monkey 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.

Passo 1: Criar um Usuário

Instruções sobre como criar um novo usuário no sistema.

Na tela de login, utilizar a opção "Cadastre-se" e seguir o fluxo.

Passo 2: Criar um Client API

Após criar seu usuário, faça login na plataforma e siga o vídeo para criar um Client API para a integração.

Passo 3: Obter o Access Token

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

Exemplo:

Propriedades da requisição

Envie os campos abaixo no corpo da requisição como application/x-www-form-urlencoded.

Propriedade	Valor	Descrição
`client_id`	Gerado ao criar o Client API.	Identificador do Client API da integração.
`client_secret`	Gerado ao criar o Client API.	Segredo do Client API da integração.
`username`	E-mail do usuário cadastrado.	E-mail do usuário de integração na plataforma.
`password`	Senha do usuário cadastrado.	Senha do usuário de integração na plataforma.
`grant_type`	`password`	Valor fixo do fluxo.
`scope`	`server`	Valor fixo do escopo da requisição.

Resposta de sucesso

Quando a requisição for concluída com sucesso, a resposta incluirá o access_token. Envie esse token em todas as requisições à plataforma.

{
  "access_token": "0000000-0000-0000-0000-00000000",
  "token_type": "bearer",
  "refresh_token": "0000000-0000-0000-0000-00000000",
  "expires_in": 430507,
  "scope": "api"
}

Envie o token nas requisições

Adicione o access_token retornado ao cabeçalho Authorization de cada requisição:

Authorization: Bearer 0000000-0000-0000-0000-00000000

Veja os detalhes da API aqui.

Passo 4: Obter os Perfis do Usuário

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 da API aqui.

Passo 5: Adicionando o usuário de integração a sua empresa

Após cadastrar uma empresa na plataforma, e a empresa estar apta a ser acessada (com status Ativa), é possível então acessa-la e incluir seu usuário de integração na relação de usuários que tem acesso a empresa. Assim seu usuário de integração conseguirá fazer login, efetuar as chamadas de apis e visualizar qualquer info a partir daquela empresa.