Autenticação

A API Vitry usa API Keys para autenticar requisições. Cada chave é gerada pelo lojista no painel admin e pode ser revogada a qualquer momento.

Gerando uma API Key

1. Acesse o painel admin → Configurações → Chaves de API
2. Clique em Gerar nova chave
3. Dê um nome descritivo (ex: "Integração Bling", "App Mobile")
4. Copie a chave imediatamente

IMPORTANTE

A chave completa é exibida apenas uma vez no momento da criação. Depois, somente os primeiros e últimos caracteres ficam visíveis. Se perdê-la, será necessário gerar uma nova.

Enviando a chave nas requisições

Envie a API key em um destes headers:

Opção 1: Header X-API-Key (recomendado)

curl -H "X-API-Key: SUA_CHAVE" https://sualoja.com.br/api/v1/products

Opção 2: Header Authorization: Bearer

curl -H "Authorization: Bearer SUA_CHAVE" https://sualoja.com.br/api/v1/products

Respostas de erro

Chave não informada

HTTP/1.1 401 Unauthorized

{
  "message": "API key não informada."
}

Chave inválida ou expirada

HTTP/1.1 401 Unauthorized

{
  "message": "API key inválida ou expirada."
}

Gerenciando chaves

No painel admin você pode:

Ação	Descrição
Gerar	Cria uma nova chave com nome identificador
Revogar	Desativa a chave (pode ser reativada depois)
Reativar	Reativa uma chave revogada
Excluir	Remove permanentemente a chave

Boas práticas

• Use uma chave diferente para cada integração
• Nomeie as chaves de forma descritiva
• Revogue chaves que não são mais usadas
• Nunca exponha chaves no frontend ou repositórios públicos
• Defina uma data de expiração quando possível

Rate Limiting

Cada chave de API permite até 60 requisições por minuto. Ao ultrapassar esse limite:

HTTP/1.1 429 Too Many Requests

O rate limit é contabilizado por chave de API. Se nenhuma chave for enviada, o limite é aplicado por IP.