Autenticação

Como autenticar suas requisições à API OctaLife usando API Keys.

Autenticação

A API OctaLife usa API Keys para autenticação. Cada chave está vinculada à sua conta de creator e tem acesso a todas as suas tribos.

Formato da API Key

TipoPrefixoExemplo
Produçãool_live_ol_live_8f92k3d7a9b2c4e6f8g0h1i2j3...
Testeol_test_ol_test_a1b2c3d4e5f6g7h8i9j0k1l2...

Use chaves ol_test_ para desenvolvimento e ol_live_ para produção.

Importante

A API Key é exibida apenas uma vez no momento da criação. Se você perder a chave, será necessário gerar uma nova.

Obtendo suas Chaves

Acesse o painel de API Keys

Navegue até Configurações → API Keys no painel do OctaLife.

Gere uma nova chave

Clique em "Gerar Nova Chave". Crie chaves separadas pra produção, staging e desenvolvimento.

Armazene com segurança

Use variáveis de ambiente, secrets manager (AWS, GCP, Azure) ou Vault. Nunca commite chaves no repositório.

Formato do Header

Authorization: Bearer ol_live_sua_chave_aqui
Content-Type: application/json

Exemplos

curl -X GET https://app.octalife.ai/api/v1/communities \
  -H "Authorization: Bearer ol_live_sua_chave_aqui" \
  -H "Content-Type: application/json"
const apiKey = process.env.OCTALIFE_API_KEY;

const response = await fetch('https://app.octalife.ai/api/v1/communities', {
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
import os, requests

response = requests.get(
    'https://app.octalife.ai/api/v1/communities',
    headers={
        'Authorization': f'Bearer {os.environ["OCTALIFE_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)

Vinculação com Creator

Cada API Key está vinculada à sua conta de creator e tem acesso a todas as suas tribos. Permite:

  • Controle de acesso: chaves separadas por ambiente ou aplicação
  • Isolamento: só acessa tribos que você criou
  • Auditoria: requisições rastreadas por chave

Gerenciamento de Chaves

Revogando

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

Revogação é imediata e irreversível. Requisições com chave revogada retornam 401 Unauthorized.

Rotação

Recomendamos rotacionar chaves a cada 90 dias:

  1. Gere nova chave
  2. Atualize aplicações
  3. Verifique funcionamento
  4. Revogue a antiga

Erros de Autenticação

CódigoErroSolução
401Missing Authorization headerAdicione header Authorization
401Invalid API key formatUse formato Bearer ol_live_...
401Invalid API keyVerifique se a chave existe e está ativa
403ForbiddenTribo não pertence ao creator da chave
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API Key inválida ou ausente"
  }
}

Boas Práticas

Faça

  • Variáveis de ambiente ou secrets manager
  • Rotação a cada 90 dias
  • Chaves de teste pra desenvolvimento
  • Monitorar uso

Não faça

  • Commitar chaves no Git
  • Expor chaves em frontend ou logs
  • Compartilhar entre devs sem rastreabilidade
  • Usar chave de teste em produção

Suporte

On this page