Openi DeveloperDeveloper
Tools

Collection Postman

Baixe a collection do Postman para testar os endpoints da API Open Finance.

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 as variáveis: a collection já vem com BASE_URL apontando para https://of.openi.com.br/v1. Preencha a variável TOKEN com sua API Key (of_test_… para sandbox; veja Autenticação). Todos os requests usam Authorization: Bearer {{TOKEN}}. Se preferir, crie um Environment (ex.: "Open Finance - Sandbox") com essas duas variáveis.
  4. Execute as requisições. Se criou um Environment, selecione-o antes no canto superior direito do Postman.

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)

Sandbox e produção usam a mesma BASE_URL; o ambiente é definido pela chave em TOKEN. No sandbox, use os CPFs de teste.

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.

On this page