OpenAPI (Postman e Insomnia)

Toda a nossa API é descrita em um arquivo OpenAPI 3.1. Além disso, oferecemos coleções prontas para importação direta no Postman e Insomnia, já com ambientes (sandbox e produção), autenticação Bearer e exemplos de requisição.

Downloads

Arquivo	Descrição
openapi.yaml	Especificação OpenAPI 3.1 completa
Coleção Postman	Collection v2.1 com todos os endpoints e exemplos
Coleção Insomnia	Export v4 com ambientes Sandbox e Produção

Os arquivos incluem todos os endpoints de vendas, assinaturas e cobranças (links de pagamento) — sempre sincronizados com a documentação da API.

Importar no Postman

Opção 1 — Coleção pronta (recomendado):

1. Clique em Import (canto superior esquerdo).
2. Arraste o arquivo azpague-postman-collection.json ou clique em Upload Files.
3. A coleção será criada com todos os endpoints organizados por módulo.
4. Edite as variáveis da coleção: preencha api_token com seu token e altere base_url para https://azpague.com.br quando for usar produção.

Opção 2 — Via OpenAPI:

1. Clique em Import e cole a URL:

   https://docs.azpague.com.br/openapi.yaml

2. O Postman gera automaticamente a coleção a partir do spec.

Importar no Insomnia

Opção 1 — Coleção pronta (recomendado):

1. Vá em Create > Import From > File.
2. Selecione o arquivo azpague-insomnia-collection.json.
3. Os ambientes Sandbox e Produção já estarão configurados. Basta preencher api_token no ambiente ativo.

Opção 2 — Via OpenAPI:

1. Vá em Create > Import From > URL.
2. Cole a URL:

   https://docs.azpague.com.br/openapi.yaml

3. Escolha importar como Request Collection.

Outras ferramentas

Qualquer ferramenta compatível com OpenAPI 3.x funciona — Bruno, HTTPie, Hoppscotch, geradores de SDK (openapi-generator, orval) e validadores.