Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Instruções para utilizar o Postman - Forlog.

https://www.postman.com/

📚 Básico

API é um acrônimo para Application Programming Interface, que significa Interface entre Aplicações, um conjunto de rotinas, protocolos e comandos que permite a comunicação entre softwares para que compartilhem funcionalidades e recursos.

O Postman permite que você execute essas API’s de uma forma simples e direta, escrevendo os dados de uma consulta e vendo o retorno exato que o sistema esta realizando.
O Padrão de integração que utilizamos é o REST, ele possui alguns tipos de chamadas, entre eles os mais comuns são:

  • GET - Para realizar consultas

  • POST - Para envio de dados

  • DELETE - Para exclusão de dados

  • PUT - Para salvar dados

Uma Chamada Rest sempre vai ter seu tipo, caso tentar executar com o tipo errado vai dar um erro 400 ou 415.

As chamadas também indicam uma URL (caminho) para serem executadas, este caminho por padrão começam com a URL do servidor onde esta hospedado e na sequencia o serviço, controle e método, ex:

https://forlog-teste.viasoftcloud.com.br:14000/TelasDinamicas/v1/Visao/Salvar

o que chamamos de UrlGateway é o trecho https://forlog-teste.viasoftcloud.com.br:14000.

Query

É possível enviar informações de consulta na própria URL, comumente utilizado em chamadas do tipo GET.

Exemplo:

{{UrlGateway}}/TmsEmbarcador/v1/Dependencia/BuscarCadastroGeral?tipo=CadCliente&busca=Teste

neste caso esta sendo passado dois filtros: tipo=CadCliente e busca=Teste o caractere ? indica o fim da escrita da URL, os parâmetros no formado de chave=valor separados por &.

Lembrando que o serviço deve estar preparado para receber estes parâmetros, portando é necessário consultar a documentação para saber quais parâmetros são suportados.

Body

É onde estará os dados a serem enviados em uma requisição, por padrão utilizamos json.

Exemplo:

Header

É possível enviar informações do cabeçalho da requisição, por padrão enviamos o token de segurança de acesso:

Obs: No caso do nosso acesso de consultas da documentação Forlog no Postman é configurado automaticamente ao executar token de acesso.

\uD83D\uDCD8 Instruções

  1. Acesse o ambiente Postman da Forlog (e-mail e senha da forlog)

  2. Selecione o ambiente que você deseja executar as chamadas

    1. no canto superior direito, selecione o ambiente.

  3. Selecione a chamada Gerar Token

    1. Envie a chamada no botão “Send” (3), deve gerar um resultado conforme o marcado na seta 4, este é o token de acesso para as próximas chamadas.

  4. Encontre a chamada que você precisa na documentação

    1. Exemplo, este get que já possui exemplos de filtros que podem ser utilizados:

  5. Considerações importantes!

    1. Não salvar alterações no método de Gerar Token caso seja necessário crie outro pois este é utilizado por outros colaboradores Forlog.

    2. As pastas “Padrão de Integração Forlog” são chamadas e documentação que estão disponível para os clientes! Portanto, não salve alteração de dados, aqui também deve ter um cuidado extra uma vez que não pode conter informações de cadastros reais apenas ilustrativos.

      1. é disponível para o cliente através do link https://documenter.getpostman.com/view/12233143/T1LTdPJc

Destaque informações importantes em um painel como este. Para editar a cor ou o estilo desse painel, selecione uma das opções no menu.

\uD83D\uDCCB Artigos relacionados

  • No labels