Autenticação — Declara API

Visão Geral

A API do Declara usa Chaves API para autenticar as requisições. Cada chave é vinculada a uma empresa específica e ao e-mail do usuário que a criou.

As chaves têm o prefixo sk_declara_ seguido de 48 caracteres hexadecimais aleatórios. Exemplo: sk_declara_a1b2c3d4e5f6...

Como Gerar uma Chave

Acesse o Declara Web e faça login

Vá em Integrações → HS Financeiro

Clique em Gerar Chave API

Copie a chave imediatamente — ela só é exibida uma vez

Guarde a chave com segurança. Não a exponha em código público ou repositórios. Se suspeitar de vazamento, desative a chave e gere uma nova.

Como Usar nos Headers

Toda requisição autenticada deve incluir dois headers obrigatórios:

HTTP Headers

X-API-Key: sk_declara_a1b2c3d4e5f6...
X-Declara-Email: seu@email.com

O e-mail deve ser o mesmo usado para criar a conta no Declara Web.

Exemplo Completo

curl -X GET "https://declara-web.vercel.app/api/v1/notas" \
  -H "X-API-Key: sk_declara_a1b2c3d4e5f6..." \
  -H "X-Declara-Email: seu@email.com"

const response = await fetch('https://declara-web.vercel.app/api/v1/notas', {
  headers: {
    'X-API-Key':       'sk_declara_a1b2c3d4e5f6...',
    'X-Declara-Email': 'seu@email.com',
  },
});
const data = await response.json();

import requests

headers = {
    'X-API-Key':       'sk_declara_a1b2c3d4e5f6...',
    'X-Declara-Email': 'seu@email.com',
}

response = requests.get(
    'https://declara-web.vercel.app/api/v1/notas',
    headers=headers
)
data = response.json()

Limites

Regra	Valor
Máximo de chaves ativas por empresa	5
Validade da chave	Sem expiração (até ser desativada)
Rate limit	100 req/min por chave