Autenticação

A API OctaBuild utiliza API Keys para autenticação. Cada chave está vinculada a uma organização específica e tem acesso completo aos recursos dessa organização.

Formato da API Key

Obtendo suas Chaves

Formato do Header

Inclua o header Authorization em todas as requisições:

Authorization: Bearer ea_live_sua_chave_aqui
Content-Type: application/json

Exemplos de Autenticação

curl -X GET https://api.octabuild.com.br/v1/land-plots \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

const apiKey = process.env.OCTABUILD_API_KEY;

const response = await fetch('https://api.octabuild.com.br/v1/land-plots', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

import os
import requests

api_key = os.environ.get('OCTABUILD_API_KEY')

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.octabuild.com.br/v1/land-plots',
    headers=headers
)

data = response.json()

<?php

$apiKey = getenv('OCTABUILD_API_KEY');
$baseUrl = 'https://api.octabuild.com.br/v1';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/land-plots',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Vinculação com Organização

Cada API Key está vinculada a uma organização específica. Isso permite:

• Controle de acesso: Cada organização tem suas próprias chaves
• Isolamento de dados: Só acessa recursos da organização vinculada
• Auditoria: Requisições são rastreadas por chave

Gerenciamento de Chaves

Revogando Chaves

Para revogar uma chave comprometida:

1. Acesse Configurações → API Keys
2. Localize a chave pelo prefixo
3. Clique em "Revogar"
4. Confirme a ação

Rotação de Chaves

Recomendamos rotacionar suas chaves periodicamente (a cada 90 dias):

1. Gere uma nova chave
2. Atualize suas aplicações para usar a nova chave
3. Monitore que tudo está funcionando
4. Revogue a chave antiga

Erros de Autenticação

Boas Práticas de Segurança

Faça

• Armazene chaves em variáveis de ambiente
• Use secrets managers em produção
• Rotacione chaves periodicamente
• Monitore o uso das chaves

Não Faça

• Commitar chaves em repositórios Git
• Expor chaves em código front-end ou logs
• Compartilhar chaves entre desenvolvedores
• Deixar chaves antigas ativas sem uso

Testando a Autenticação

curl -X GET https://api.octabuild.com.br/v1/land-plots \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Resposta de sucesso:

{
  "success": true,
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 0,
    "pages": 0
  }
}

Suporte

Problemas com autenticação?

• Email: suporte@octabuild.com.br
• Documentação: Início Rápido