Introdução
Bem-vindo à documentação da API OctaBuild. Integre gestão de terrenos, empreendimentos e unidades imobiliárias em sua aplicação.
Documentação da API OctaBuild
Integre a gestão de incorporação imobiliária diretamente em suas aplicações. Acesse terrenos, empreendimentos, unidades e financeiro de forma programática.
API RESTful
A API OctaBuild é RESTful, utiliza JSON para requests/responses e autenticação via API Key no header Authorization.
O que a API oferece
┌─────────────────────────────────────────────────────────────┐
│ Sua Aplicação │
└─────────────────────────┬───────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ API OctaBuild │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ • Autenticação por API Key │ │
│ │ • Banco de Terrenos (Land Plots) │ │
│ │ • Empreendimentos (Developments) │ │
│ │ • Unidades Autônomas (Units) │ │
│ │ • Clientes (PF/PJ) │ │
│ │ • Financeiro (Contas a Pagar/Receber) │ │
│ │ • Webhooks para eventos em tempo real │ │
│ └───────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘Por que usar a API OctaBuild?
| Benefício | Descrição |
|---|---|
| Integração Completa | Conecte seu sistema ao OctaBuild sem precisar acessar a interface web |
| Automação | Crie terrenos, empreendimentos e unidades automaticamente |
| Sincronização | Mantenha seus sistemas sincronizados via webhooks |
| Escalabilidade | API otimizada para alto volume de requisições |
| Segurança | Autenticação via API Key com escopo por organização |
Primeiros Passos
Obtenha suas credenciais
Acesse Configurações → API Keys no painel do OctaBuild e gere suas chaves de API.
Cada chave está vinculada à sua organização e tem acesso completo aos recursos da organização.
Configure a autenticação
Todas as requisições devem incluir o header Authorization com sua API Key.
Authorization: Bearer ea_live_sua_chave_aquiFaça sua primeira requisição
Teste a conexão listando seus terrenos:
curl -X GET https://api.octabuild.com.br/v1/land-plots \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json"Base URL
Todas as requisições devem ser feitas para:
https://api.octabuild.com.br/v1Fluxo Típico de Integração
1. Cadastrar Terreno → POST /v1/land-plots
↓
2. Criar Empreendimento → POST /v1/developments
↓
3. Cadastrar Unidades → POST /v1/developments/:id/units
↓
4. Acompanhar Financeiro → GET /v1/financial/dashboardRecursos Disponíveis
Autenticação
Como autenticar suas requisições e gerenciar API Keys
Terrenos
Gerenciar banco de terrenos, due diligence e certidões
Empreendimentos
Criar e gerenciar empreendimentos imobiliários
Unidades
Gerenciar unidades autônomas de empreendimentos
Clientes
Gerenciar clientes (Pessoa Física e Jurídica)
Financeiro
Controlar contas a pagar, receber e fornecedores
Webhooks
Receber notificações de eventos em tempo real
Conceitos Importantes
Organizações
Todos os recursos pertencem a uma organização. Sua API Key está vinculada a uma organização específica e só pode acessar recursos dessa organização.
Terrenos vs Empreendimentos
- Terreno (Land Plot): Um terreno cadastrado no banco de terrenos, em processo de prospecção, análise ou aquisição
- Empreendimento (Development): Um projeto de incorporação vinculado a um terreno adquirido, com blocos, tipologias e unidades
Clientes
Clientes podem ser:
- Pessoa Física (PF): CPF, RG, dados pessoais
- Pessoa Jurídica (PJ): CNPJ, razão social, dados empresariais
Status dos Terrenos
Terrenos seguem um pipeline de etapas:
prospeccao→analise_preliminar→estudo_massa→negociacao→due_diligence→aprovado→adquirido- Também podem ser descartados:
descartado
Limites de Uso
| Plano | Requisições/Minuto | Requisições/Dia |
|---|---|---|
| Starter | 60 | 1.000 |
| Professional | 300 | 10.000 |
| Enterprise | 1.000 | Ilimitado |
Exceder os limites resultará em resposta 429 Too Many Requests. Implemente retry com backoff exponencial.
Suporte
Precisa de ajuda com sua integração?
- Email: suporte@octabuild.com.br
- Documentação: Você está aqui!