API pública Condoa

OAuth 2.0 client credentials, webhooks assinados, cobranças PIX e boleto em uma única chamada, ledger completo. Tudo escopado por condomínio.

Começar agora OpenAPI 3.1 (YAML) Coleção Postman

Começando

Crie seu sandbox para obter um client_id e um client_secret (mostrado uma única vez) vinculados a um condomínio de teste.
Troque por um access token em POST /api/v1/oauth/token com grant_type=client_credentials.
Envie o header Authorization: Bearer <token> em todas as chamadas seguintes.
Em requisições que mudam estado, mande Idempotency-Key: <ulid> para poder repetir com segurança em caso de falha de rede (janela de 24h).

Headers

Headers comuns a toda a API. Authorization e Content-Type são de chamada; os demais a Condoa emite (ou aceita) para te dar correlação de logs e segurança contra dupla cobrança.

Header	Direção	Quando usar
Authorization	Envia
Content-Type	Envia
Idempotency-Key	Envia
X-Request-Id	Envia + recebe
Idempotency-Replayed	Recebe
X-RateLimit-Limit	Recebe
X-RateLimit-Remaining	Recebe
Retry-After	Recebe

Escopos

Cada token é vinculado a um condomínio e a um conjunto de escopos. Peça apenas o que for usar.

Escopo	O que libera
invoices.read / .write	Cobranças, items, payment options, inadimplência, índices monetários
expenses.read / .write	Despesas, parcelas, anexos, dados de pagamento do fornecedor
cadastros.read / .write	Condomínios, blocos, unidades, moradores, veículos, funcionários, fornecedores
bank.read / .write	Contas bancárias, movimentos, conciliação, importação de extrato
plano-de-contas.read / .write	Plano de contas, lançamentos, transferências, períodos
webhooks.manage	Assinaturas de webhooks