Pular para o conteúdo principal

Usando o Conota no Postman

O Postman importa a especificação OpenAPI e cria uma collection com os endpoints.

Importando

  1. abra Import no Postman;
  2. escolha importação por link;
  3. informe:
https://api.conota.dev/docs/json
  1. confirme a criação da collection.

Configurando a chave

  1. crie um Environment (por exemplo Conota — homologação);
  2. adicione uma variável apiKey do tipo secret;
  3. na collection, configure o header:
X-API-Key: {{apiKey}}
Nunca grave a chave dentro da collection

Collection é arquivo, e arquivo vai para o Git ou para um workspace compartilhado. Use variável de ambiente do tipo secret, e mantenha environments separados para homologação e produção — com nomes que não deixem dúvida sobre qual está ativo.

Sugestão de organização

Crie dois environments com nomes explícitos e cores diferentes, se o seu Postman permitir. O acidente clássico dessa API é executar em produção achando que está em homologação.