Início

A Business API é a interface machine-to-machine da plataforma Openi Business. Com ela, sistemas externos consultam os dados das empresas às quais o dono da chave tem acesso: contas bancárias, transações, lançamentos contábeis, investimentos e campos personalizados.

• Base URL: https://api-business.openi.com.br/api/v1
• Autenticação: chave de API por usuário, enviada como Authorization: Bearer oak_...
• Formato: todas as respostas seguem o envelope { "status": "success", "data": ... }
• Somente leitura: todos os endpoints são GET, exceto a busca de lançamentos de investimentos (POST que só consulta)
• Filtros: toda listagem filtra por qualquer campo da resposta — datas, valores, textos, status e campos personalizados

Por onde começar

1. Autenticação — crie sua chave de API na plataforma e entenda o formato do token, revogação, expiração e o log de uso.
2. Padrões da API — catálogo de endpoints e as convenções comuns: período from/to, datas, valores, paginação e erros.
3. Filtros, ordenação e busca — o formato único de filtro, operadores, ordenação e busca.
4. Contas bancárias — contas, transações, transações por dia e fluxo de caixa.
5. Investimentos — posições consolidadas por data de referência.
6. Contabilidade — lançamentos contábeis e de investimentos, totais e atributos.
7. Campos personalizados — definições, valores por conta e histórico.
8. Collection Postman — baixe a collection para testar todos os endpoints sem codar.

Escopo de acesso

Cada chave pertence a um usuário da plataforma e enxerga exatamente as empresas das quais esse usuário é dono ou membro — não há allowlist por chave. O companyId sempre vai no caminho da URL:

GET https://api-business.openi.com.br/api/v1/companies/{companyId}/bank-accounts
Authorization: Bearer oak_368ba506f7b2_9f2c...

Uma requisição para uma empresa fora do escopo do dono da chave retorna 404.

Onde encontrar o companyId

A API não expõe um endpoint de listagem de empresas. Pegue o companyId na URL da plataforma ao abrir a empresa — https://app.openi.com.br/company/{companyId}/....