Como configurar o Postman para testar as API's do Zeev?

Como importar a coleção do Zeev no Postman?

Para realizar testes das API's zeev com o Postman, é possível importar os dados de OpenAPI exportados automaticamente pelo zeev no seu ambiente. Existem algumas práticas que vão ajuda-lo a obter a documentação do Zeev no seu Postman de forma mais organizada oferecendo um melhor proveito. Para isso siga os passos abaixo:

  1. Obtenha o Postman: Instale o Postman ou obtenha uma conta gratuita para uso online. Neste tutorial vamos utilizar a versão Desktop Instalada em um computador windows;

  2. Obtenha uma conta no Postman: No primeiro acesso será solicitado a criação de uma conta gratuita no Postman. Você deve cria-la ou apenas autenticar-se se já for um usuário cadastrado.

  3. Importe a coleção do Zeev: Clique em import

  4. Informar a origem da documentação: Na nova janela que surgir, informe o endereço https://seu_dominio.do.zeev/api/2/docs, informe no lugar de seu_dominio.do.zeev o endereço que você utilizada para acessar o Zeev. Ou se preferir, faça download do Modelo para download do Zeev OpenAPI e importe no seu ambiente:

  5. Configure a importação: Após informar o endereço do OpenAPI.json ou importar o modelo disponibilizado, cliente em view import settings na janela que surgir, e altere o parâmetro "folder organization" de paths para tags, depois volte e clique em import:

  6. Configure o seu endereço: Se você importou o modelo desta página, clique nos três pontos a frente da pasta criada para a coleção, depois clique em varáveis e informe o seu endereço do Zeev:

  7. Configure a autenticação em nível global: Ainda na pasta da coleção, clique na guia Authorization, troque Auth Type para Bearer Token, e informe um token válido de usuário do Zeev e clique em salvar. Com esta configuração, os endpoints "herdam" a autorização e você não vai precisar inclui-las manualmente em todas as chamadas.

Modelo para download do Zeev OpenAPI

Atualizado