Vigilbase para programadores
Guia rápido
Execute uma análise não intrusiva de cabeçalhos de segurança sem autenticação:
curl -sS -X POST https://vigilbase.com/api/v1/agent/tools/security-headers/execute \
-H "Content-Type: application/json" \
-d '{"target":"https://example.com"}'Verificação da autenticação de email:
curl -sS -X POST https://vigilbase.com/api/v1/agent/tools/email-security/execute \
-H "Content-Type: application/json" \
-d '{"target":"example.com"}'CLI: npx @vigilbase/cli run security-headers https://example.com --json
Autenticação e permissões
Os pedidos anónimos têm as permissões gratuitas tools:read, tools:execute, e badges:read com um limite de 10 pedidos por minuto por IP.
As chaves de API opcionais para programadores (criadas em one.vigilbase.com/developers) aumentam o limite para 30 pedidos por minuto. As chaves estão associadas ao utilizador — pertencem à sua conta Vigilbase One. Envie Authorization: Bearer <key> ou X-Api-Key: <key>.
tools:read— listar ferramentas para agentestools:execute— executar análises autorizadasbadges:read— selos com a classificação de segurança
Chaves de API para programadores
Crie gratuitamente chaves de API na Vigilbase One — o registo demora cerca de um minuto e dispensa um formulário comercial. As chaves estão associadas ao utilizador, incluem tools:read, tools:execute, e badges:read, e aumentam o limite dos agentes para 30 pedidos por minuto em vigilbase.com.
curl -sS https://vigilbase.com/api/v1/agent/tools \ -H "Authorization: Bearer YOUR_ONE_API_KEY"
Endpoints da API
GET /api/v1/agent/tools— catálogoPOST /api/v1/agent/tools/security-headers/executePOST /api/v1/agent/tools/email-security/executePOST /api/v1/developer/keys— descontinuado; crie as chaves na OneGET /api/badge/{domain}— selo SVGGET /openapi.json— documento OpenAPI 3.1
Os aliases antigos /api/agent/* continuam a funcionar e devolvem cabeçalhos Deprecation / Sunset que indicam a versão v1 sucessora.
Erros JSON tipados
As falhas devolvem application/problem+json (RFC 9457) com um code legível por máquinas, message/detail legíveis por pessoas, e um hint opcional para ajudar na recuperação.
{
"success": false,
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Retry after the indicated delay.",
"hint": "Free tier allows 10 requests/minute. Create a developer API key on One for a higher limit."
},
"type": "https://vigilbase.com/developers/errors/rate-limit-exceeded",
"title": "Rate Limit Exceeded",
"status": 429,
"detail": "Rate limit exceeded. Retry after the indicated delay.",
"code": "rate_limit_exceeded",
"retryAfterSec": 12
}Limites de pedidos
As respostas incluem os cabeçalhos RateLimit e RateLimit-Policy, além de RateLimit-Limit / RateLimit-Remaining / RateLimit-Reset e X-RateLimit-* como aliases. O estado HTTP 429 inclui Retry-After.
Versões e descontinuação
A versão principal atual é a v1 em /api/v1/. As respostas incluem API-Version: 1. As alterações incompatíveis serão publicadas em /api/v2/. Os aliases descontinuados sem versão incluem Deprecation: true, uma data Sunset e um cabeçalho Link rel="successor-version".
Quando utilizar as APIs da Vigilbase
- Classificar cabeçalhos de segurança HTTP ou autenticação de email (SPF/DKIM/DMARC) a partir de um agente, sem controlar um navegador
- Incorporar um selo com uma classificação de segurança do site já medida
- Descobrir capacidades para agentes através de
/.well-known/agent-skills/index.json
Utilize a interface no navegador (com verificação de email) para análises intrusivas como website-security e react2shell.