Documentação da API
Inicie verificações e consulte resultados e relatórios pela API REST.
Autenticação
Use Authorization: Bearer <API_KEY> e não exponha a chave em código público.
Crie uma chave em Painel → Configurações → Chaves de API.
curl -H "Authorization: Bearer YOUR_API_KEY" https://issafesite.com/api/v1/scanURL base
https://issafesite.com/api/v1Limites
Grátis: 3 verificações diárias e 10 solicitações por minuto. Pro: 50 diárias e 60 por minuto. Team: verificações ilimitadas e 300 solicitações por minuto.
| Detalhes dos planos | Verificações por dia | Solicitações por minuto |
|---|---|---|
| Free | 3 | 10 |
| Pro | 50 | 60 |
| Team | ∞ | 300 |
Endpoints
POST /api/v1/scan cria uma verificação; GET /api/v1/scan lista verificações; GET /api/v1/report recupera relatórios.
POST /api/v1/scan
O corpo POST exige url; depth aceita QUICK, STANDARD (padrão) ou DEEP. As listas aceitam page (1) e limit (20, máximo 50); relatórios podem ser filtrados por scanId.
curl -X POST https://issafesite.com/api/v1/scan \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com","depth":"STANDARD"}'202 · Criado
GET /api/v1/scan
Parâmetros: Página=1, Limite=20 (≤50)
curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/scan?page=1&limit=10"GET /api/v1/report
Parâmetros: scanId, Página, Limite
curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/report?scanId=clx1abc"Erros
A criação retorna 202 e as listas 200. Erros JSON incluem error; 401 indica chave ausente e 403 chave inválida ou expirada.
{ "error": "..." }| 400 | Parâmetros ausentes ou inválidos |
| 401 | Chave de API ausente |
| 403 | Chave inválida ou expirada |
| 429 | Limite de solicitações ou cota excedida |
| 500 | Erro interno do servidor |
Início rápido
Inicie verificações e consulte resultados e relatórios pela API REST.
curl -X POST https://issafesite.com/api/v1/scan \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com","depth":"STANDARD"}'Suporte
Observe os limites do plano. Em caso de falha, confira o status HTTP e a resposta JSON.
support@issafesite.com