Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


Painel
borderColorblack
borderWidth1
borderStylesolid

Índice

Índice

...

Informações
titleAUTORIZAÇÃO GERAL

IP:PORTA/mk/WSAutenticacao.rule?sys=MK0&token=&password=&cd_servico=9999

Agora na Query devem ser adicionados os seguintes parâmetros:

...

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):

Image Removed

Informe o nome da requisição e selecione o tipo dela GET, POST ou PUT. O tipo fica indicado na nossa documentação junto com a URL e segue este padrão:

  • 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):

...

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

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:

...

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

Image Removed

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 cidadesComo o ambiente já foi configurado basta digitar _ (sustenido) > selecionar a opção e colar a URL:

Image RemovedImage Added

Agora na Na aba Query devem ser adicionados os parâmetros. Conforme a documentação nesta requisição são utilizados vários parâmetrosdeve ser adicionado o parâmetro do token que autoriza o uso da API e do código do que será alterado por ela:

  • 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)

...

  • da cidade que será alterada (Obrigatório)

Agora na aba JSON devem ser adicionados os parâmetros da API, adicione os que são obrigatórios e os opcionais que desejar conforme a documentação. Quando concluir basta clicar em Send para fazer a consulta.

Image Added

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 HTTP Request (ou utilize o atalho Ctrl + N)Image Removed

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

Na aba Query deve ser adicionado o parâmetro do token que autoriza o uso da API:

...

  • token - token de retorno da autenticação (Obrigatório)

Image Added

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

...

  • nome - nome da cidade (Obrigatório)
  • IBGE - código do IBGE da cidade (Obrigatório)
  • estado - código do estado (Obrigatório)

...

Image Added