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, parâmetros e respostas antes de codar.

Download da collection

A collection reúne todos os endpoints da Business API já configurados, com a URL de produção como padrão.

Baixar Business API - Postman Collection

• Arquivo: business-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.
3. Preencha as variáveis da collection (aba Variables):
   • apiKey — sua chave oak_..., criada conforme Autenticação. Os requests usam Authorization: Bearer {{apiKey}}.
   • companyId — o id da empresa, disponível na URL da plataforma: https://app.openi.com.br/company/{companyId}/....
   • baseUrl já vem preenchida com https://api-business.openi.com.br/api/v1; só altere para apontar para outro ambiente.
4. Execute as requisições. Rode primeiro Listar contas, Listar definições de campos e Listar investimentos — elas preenchem automaticamente bankAccountId, fieldId e investmentId, usados pelos demais requests.

Endpoints incluídos

• Contas bancárias — listar contas, transações, transações por dia e fluxo de caixa por dia
• Investimentos — listar posições consolidadas
• Contabilidade — lançamentos bancários e de investimentos, totais, busca por corpo e atributos para filtros
• Campos personalizados — definições, valores por conta e histórico de um campo

As requisições de listagem já trazem from/to, filters, sort e search como parâmetros desativados com exemplos — marque-os na aba Params para testar. O Postman faz o URL-encoding do JSON automaticamente. Os padrões estão em Padrões da API e o formato de filtro em Filtros, ordenação e busca.

Todos os endpoints são somente leitura e escopados por empresa. Uma requisição para uma empresa fora do escopo da chave retorna 404.