DataBolsa docs
Referência da API

Visão geral

Referência completa da API do DataBolsa Advisor, gerada do contrato OpenAPI do escritório.

A API do Advisor é a camada organizacional do DataBolsa em REST + JSON:

https://api.databolsa.com/v1/advisor

Contrato próprio, separado do core: api.databolsa.com/openapi-advisor.json. Nada dele entra no contrato do DataBolsa — as duas superfícies evoluem lado a lado e nunca colidem.

Autenticação

Header Authorization: Bearer <credencial>, em dois formatos:

  • Chave de organização db_org_... — a credencial de serviço do escritório (escopo full ou read), criada no portal em Config.
  • Sessão do portal — quando quem chama é uma pessoa, o papel e a visibilidade seguem o assento dela. A chave pessoal do produto B2C não vale aqui: ela pertence a outro realm de identidade.

Grupos de endpoints

GrupoO que cobre
Contaidentidade do chamador e aceite de convite
Organizaçãodados da org, membros, papéis, convites, licença e chaves
Clientesclientes, famílias, assessor responsável e perfil
Carteirascarteiras por cliente — ativos, ledger, posições e evolução
Auditoriatrilha de tudo que foi escrito na organização

Comportamento que vale em toda rota

  • 404 é escopo. Recurso de outra organização — ou fora da sua visibilidade de clientes — responde 404, nunca 403.
  • 402 é licença. Licença vencida bloqueia escritas com code: license_required; as leituras continuam.
  • Toda escrita é auditada, na mesma transação da mudança.
  • Erros seguem application/problem+json (RFC 9457).

A referência é gerada do contrato — cada página traz parâmetros, respostas e exemplos prontos.