Collection Postman

Use a collection do Postman para testar a API sem precisar integrar direto na sua aplicação. Isso ajuda a validar autenticação, payloads e respostas antes de codar.

Download da collection

A collection reúne os principais endpoints da API (conectores, itens, contas, transações, webhooks) já configurados.

Baixar Open Finance API - Postman Collection

• Arquivo: openfinance-postman-collection.json
• Formato: Postman Collection v2.1

Como usar

1. Instale o Postman (ou use Postman for Web) em postman.com.
2. Importe a collection: no Postman, vá em Import e arraste o arquivo baixado ou selecione-o. Também é possível usar Import → Link e colar a URL da collection (por exemplo, a URL do arquivo hospedado nesta documentação).
3. Configure a variável de ambiente:
   • Crie um Environment no Postman (ex.: "Open Finance - Sandbox").
   • Adicione a variável baseUrl com a URL base da API (ex.: https://api.openfinance.exemplo.com/v1 ou a URL fornecida pelo time Open Finance).
   • Adicione a variável apiKey com sua API Key (Bearer token). Os requests da collection usam Authorization: Bearer {{apiKey}}.
4. Selecione o environment no canto superior direito do Postman e execute as requisições.

Endpoints incluídos

A collection inclui exemplos para:

• Webhooks — criar, listar, buscar, atualizar e remover webhooks
• Conectores — listar e buscar conectores
• Connect — criar sessão de conexão para o widget Connect
• Itens — criar item, buscar item, listar itens, ressincronizar
• Contas — listar contas do item
• Transações — listar transações (conta bancária e cartão)

Ajuste baseUrl e apiKey conforme seu ambiente (sandbox/produção) e as credenciais fornecidas.

Observação

Se a URL de download acima não estiver disponível no seu ambiente, o time Open Finance pode enviar o arquivo openfinance-postman-collection.json por outro canal (e-mail, Slack, etc.). O conteúdo da collection é o mesmo.