Início Rápido
Comece a usar a API OctaBuild em 5 minutos
Início Rápido
Este guia mostra como fazer sua primeira integração com a API OctaBuild. Ao final, você terá criado um terreno e um empreendimento via API.
Pré-requisitos
- Conta ativa no OctaBuild
- API Key gerada (veja Autenticação)
Obtenha sua API Key
- Acesse o painel do OctaBuild
- Navegue até Configurações → API Keys
- Clique em Criar Nova Chave
- Copie sua chave (formato:
ea_live_...)
Guarde sua API Key em segurança. Ela não será exibida novamente!
Cadastre seu primeiro terreno
curl -X POST https://api.octabuild.com.br/v1/land-plots \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"name": "Terreno Alphaville",
"address": "Av. Principal, 1200",
"city": "Barueri",
"state": "SP",
"total_area_m2": 5000,
"asking_price": 2500000.00,
"zoning": "ZR-2",
"owner_name": "João da Silva",
"status": "prospeccao",
"priority": 2
}'const response = await fetch('https://api.octabuild.com.br/v1/land-plots', {
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.OCTABUILD_API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Terreno Alphaville',
address: 'Av. Principal, 1200',
city: 'Barueri',
state: 'SP',
total_area_m2: 5000,
asking_price: 2500000.00,
zoning: 'ZR-2',
owner_name: 'João da Silva',
status: 'prospeccao',
priority: 2
})
});
const data = await response.json();
console.log('Terreno criado:', data.data.id);import requests, os
response = requests.post(
'https://api.octabuild.com.br/v1/land-plots',
headers={
'Authorization': f'Bearer {os.environ["OCTABUILD_API_KEY"]}',
'Content-Type': 'application/json'
},
json={
'name': 'Terreno Alphaville',
'address': 'Av. Principal, 1200',
'city': 'Barueri',
'state': 'SP',
'total_area_m2': 5000,
'asking_price': 2500000.00,
'zoning': 'ZR-2',
'owner_name': 'João da Silva',
'status': 'prospeccao',
'priority': 2
}
)
data = response.json()
print(f"Terreno criado: {data['data']['id']}")Resposta:
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Terreno Alphaville",
"address": "Av. Principal, 1200",
"city": "Barueri",
"state": "SP",
"total_area_m2": 5000,
"asking_price": 2500000.00,
"zoning": "ZR-2",
"status": "prospeccao",
"priority": 2,
"created_at": "2026-02-25T10:30:00Z"
}
}Crie um empreendimento
curl -X POST https://api.octabuild.com.br/v1/developments \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"name": "Residencial Alphaville Park",
"land_plot_id": "550e8400-e29b-41d4-a716-446655440000",
"type": "residencial_vertical",
"city": "Barueri",
"state": "SP",
"total_units": 120,
"total_blocks": 2,
"total_floors": 15,
"phase": "concepcao"
}'Resposta:
{
"success": true,
"data": {
"id": "660e8400-e29b-41d4-a716-446655440001",
"name": "Residencial Alphaville Park",
"land_plot_id": "550e8400-e29b-41d4-a716-446655440000",
"type": "residencial_vertical",
"total_units": 120,
"total_blocks": 2,
"total_floors": 15,
"phase": "concepcao",
"created_at": "2026-02-25T10:31:00Z"
}
}Liste seus terrenos
curl -X GET "https://api.octabuild.com.br/v1/land-plots?status=prospeccao" \
-H "Authorization: Bearer ea_live_sua_chave_aqui"Resposta:
{
"success": true,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Terreno Alphaville",
"city": "Barueri",
"state": "SP",
"total_area_m2": 5000,
"asking_price": 2500000.00,
"status": "prospeccao",
"priority": 2
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
}
}Próximos Passos
- Terrenos - Documentação completa do banco de terrenos
- Empreendimentos - Gerenciar empreendimentos
- Unidades - Cadastrar unidades autônomas
- Financeiro - Contas a pagar e receber
- Webhooks - Receber notificações em tempo real
Precisa de Ajuda?
- Email: suporte@octabuild.com.br
- Documentação: Você está aqui!