Pré-Requisitos

• URL da API selecionada (caso seja uma API Especial converse com a nossa equipe comercial para mais informações)
• Acesso ao Insomnia
• Para APIs do tipo POST ou PUT servidor com Ubuntu na versão 16.04 ou superior

Gerando o token de autorização

O primeiro passo para consumir uma das APIs é gerar o token de autorização, conforme a nossa documentação. Isso trás mais segurança para o processo pois garante que somente usuários cadastros no sistema e com permissão na configuração das APIs terão acesso as requisições.

...

Após adicionar os parâmetros basta clicar em Send para fazer a consulta. Observe que no retorno será informado o Token de autorização. É ele que vai ser utilizado para consumir todas as APIs.

Gerando o ambiente

Para que não seja necessário informar o ambiente (IP ou https do mk) em cada requisição o Insomnia possui variáveis de ambiente, que podem ser reutilizadas. Para criar, basta clicar em No Environment > Manage Environments abaixo do menu principal do Insomnia:

Veja o exemplo para uso:

Consumindo uma API

Para consumir a primeira requisição basta clicar sobre o botão com símbolo de mais (+) e então clicar em New Request (ou utilizar o atalho Ctrl + N):

...

• Consultas/listas: tipo GET
• Alteração: tipo PUT
• Inclusão: tipo POST

APIs do tipo GET

A API para listar ordens de serviço por código é uma requisição do tipo GET (consulta):

...

Após a criação será aberto o painel para que seja informada a URL da API na parte superior, ao lado do método, que neste caso é GET. A URL de nossa API para listar as OS por código é: /os/id Como o ambiente já foi configurado basta digitar _ (sustenido) > selecionar a opção e colar a URL:

...

Após adicionar os parâmetros basta clicar em Send para fazer a consulta.

APIS do tipo PUT

A API para alterar o cadastro de um cliente é uma requisição do tipo PUT (alteração):

...

Após a criação será aberto o painel para que seja informada a URL da API na parte superior, ao lado do método, que neste caso é PUT. A URL de nossa API para listar as OS por código é: /pessoas Como o ambiente já foi configurado basta digitar _ (sustenido) > selecionar a opção e colar a URL:

Agora na Query devem ser adicionados os parâmetros. Conforme a documentação nesta requisição são utilizados vários parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• id - código do cadastro do cliente (Obrigatório)
• email - novo email do cliente (Opcional)
• classificacao - nova classificação para o cliente (Opcional)
• nascimento - data de nascimento (Opcional)
• fone - novo número do celular (Opcional)
• estadoId - novo estado (endereço geral) (Opcional)
• estadoCobrancaId - novo estado (endereço de cobrança) (Opcional)
• cidadeId - nova cidade (endereço geral) (Opcional)
• cidadeCobrancaId - nova cidade (endereço de cobrança) (Opcional)
• bairroId - novo bairro (endereço geral) (Opcional)
• bairroCobrancaId - novo bairro (endereço de cobrança) (Opcional)
• logradouroId - novo logradouro (endereço geral) (Opcional)
• logradouroCobrancaId - novo logradouro (endereço de cobrança) (Opcional)
• numero - novo logradouro (endereço geral) (Opcional)
• numeroCobranca - novo logradouro (endereço de cobrança) (Opcional)
• cep - novo CEP (endereço geral) (Opcional)
• cepCobranca - novo CEP (endereço de cobrança) (Opcional)

Adicione os que são obrigatórios e os opcionais que desejar. Quando concluir basta clicar em Send para fazer a consulta.

APIS do tipo POST

A API para criar cidades por código é uma requisição do tipo POST (inclusão):

Image Modified

No Insomnia deve ser cadastrada da mesma forma: clique sobre o botão com símbolo de mais (+) > New Request (ou utilize o atalho Ctrl + N)

Após a criação será aberto o painel para que seja informada a URL da API na parte superior, ao lado do método, que neste caso é POST. A URL de nossa API para listar as OS por código é: /cidades Como o ambiente já foi configurado basta digitar _ (sustenido) > selecionar a opção e colar a URL:

Agora na Query devem ser adicionados os parâmetros. Conforme a documentação nesta requisição são utilizados vários parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• nome - nome da cidade (Obrigatório)
• IBGE - código do IBGE da cidade (Obrigatório)
• estado - código do estado (Obrigatório)

Adicione os que são obrigatórios e os opcionais que desejar. Quando concluir basta clicar em Send para fazer a consulta.