Skip to content
IsSafeSite

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.

Endpoints

POST /api/v1/scan cria uma verificação; GET /api/v1/scan lista verificações; GET /api/v1/report recupera relatórios.

Limites e erros

Observe os limites do plano. Em caso de falha, confira o status HTTP e a resposta JSON.

Crie uma chave em Painel → Configurações → Chaves de API.

https://issafesite.com/api/v1

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.

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"}'

A criação retorna 202 e as listas 200. Erros JSON incluem error; 401 indica chave ausente e 403 chave inválida ou expirada.

Veja todos os detalhes em inglês