Pular para o conteúdo principal

Testando endpoints com Swagger

O Swagger UI do Conota está em:

api.conota.dev/swagger

É um console de desenvolvimento: explora e executa endpoints com a sua chave.

Como autenticar

  1. abra o Swagger;
  2. clique em Authorize;
  3. cole a API Key no campo apiKey (header X-API-Key);
  4. execute qualquer endpoint com Try it out.

Quando usar

  • testar autenticação;
  • validar rapidamente um payload;
  • conferir a forma de uma resposta;
  • reproduzir uma chamada durante um diagnóstico.

Quando não usar

Cuidado ao apertar "Execute" apontando para produção

O Swagger executa de verdade. Um POST /v1/nfe/emitir com a chave de produção emite uma nota com efeito fiscal. Confirme o ambiente antes.

O Swagger também não substitui uma integração de backend nem é uma boa fonte para entender os fluxos fiscais. Para aprender a integrar, use este portal; para consultar schemas, use o ReDoc.