​

Autenticação

​

Header de autenticação

X-API-Key: indiqai_sua_chave_aqui

​

Regras da autenticação pública

• a chave precisa ter acesso à superfície pública da sua conta
• o plano da empresa precisa ter api_access=true
• a empresa sempre é derivada da chave, não do body nem da query string

​

Exemplo de requisição autenticada

curl -X GET "https://api.indiqai.com/api/v1/public/clients" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

const response = await fetch('https://api.indiqai.com/api/v1/public/clients', {
  headers: {
    'X-API-Key': 'indiqai_sua_chave_aqui'
  }
});

const data = await response.json();

import httpx

response = httpx.get(
    'https://api.indiqai.com/api/v1/public/clients',
    headers={'X-API-Key': 'indiqai_sua_chave_aqui'}
)

data = response.json()

​

Respostas de erro de autenticação

​

422 — Header ausente

{
  "error": "validation_error",
  "message": "Dados inválidos na requisição",
  "details": [
    {
      "type": "missing",
      "loc": ["header", "X-API-Key"],
      "msg": "Field required",
      "input": null
    }
  ],
  "correlation_id": "<uuid>"
}

​

401 — Formato incorreto

{
  "error": "http_error",
  "message": "API Key inválida: formato incorreto",
  "detail": "API Key inválida: formato incorreto",
  "correlation_id": "<uuid>"
}

​

401 — API Key inválida ou revogada

{
  "error": "http_error",
  "message": "API Key inválida ou revogada",
  "detail": "API Key inválida ou revogada",
  "correlation_id": "<uuid>"
}

​

Plano sem acesso à API

{
  "detail": "Plano da empresa não permite acesso à API Pública. Faça upgrade para um plano com api_access."
}

​

403 — Chave sem acesso a esta superfície

​

Segurança

• A chave completa é exibida apenas uma vez na criação
• Revogue chaves comprometidas imediatamente no Dashboard
• Use chaves separadas para ambientes (produção, staging, testes)
• Todas as requisições devem usar HTTPS
• Toda chamada autenticada opera automaticamente no contexto da sua empresa

​

Gerenciando API Keys

• Criar novas chaves com nome descritivo
• Listar chaves ativas (apenas prefixo visível)
• Revogar chaves que não são mais necessárias