HelpFraud · Documentação para desenvolvedores

Ligue o seu servidor à API Business HelpFraud.

Chaves de API OpenAPI 3.0.3 Novos domínios

Authorization · BUSINESS

Envie Authorization: Bearer hf_live_example. Não é uma chave real. Guarde as chaves no servidor, nunca no navegador ou em URLs.

As chaves autenticam os seus pedidos à API da HelpFraud. A chave completa é mostrada apenas uma vez.

US$ 4,99 / Mensal

As suas verificações

Use input e type opcional. Os endpoints específicos selecionam o seu analisador. São indicadores de risco, não provas de fraude; fornecedores externos não ligados.

Bulk aceita 1–50 itens. Cada um consome uma unidade mensal da API. Os erros são devolvidos por item. Máximo 256 KiB por pedido.

POST/api/v1/check

curl -X POST 'https://helpfraud.com/api/v1/check' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"https://example.com","type":"WEBSITE"}'

POST/api/v1/check/url

curl -X POST 'https://helpfraud.com/api/v1/check/url' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"https://example.com"}'

POST/api/v1/check/message

curl -X POST 'https://helpfraud.com/api/v1/check/message' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"Please verify this message."}'

POST/api/v1/check/email

curl -X POST 'https://helpfraud.com/api/v1/check/email' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"support@example.com"}'

POST/api/v1/check/phone

curl -X POST 'https://helpfraud.com/api/v1/check/phone' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"+442079460123"}'

POST/api/v1/check/bulk

curl -X POST 'https://helpfraud.com/api/v1/check/bulk' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"input":"https://example.com","type":"WEBSITE"}]}'

GET/api/v1/domain/{domain}

curl 'https://helpfraud.com/api/v1/domain/{domain}' -H 'Authorization: Bearer hf_live_example'

GET/api/v1/domains/recent

curl 'https://helpfraud.com/api/v1/domains/recent' -H 'Authorization: Bearer hf_live_example'

GET/api/v1/alerts

curl 'https://helpfraud.com/api/v1/alerts' -H 'Authorization: Bearer hf_live_example'

GET/api/v1/openapi.json

curl 'https://helpfraud.com/api/v1/openapi.json'

Limite de taxa

Business: 60 unidades por minuto móvel e 5.000 unidades por mês civil. Erros: error.code, error.message, error.request_id. 429 inclui retry-after.

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "API request limit exceeded.",
    "request_id": "example-request-id"
  }
}

INVALID_REQUEST: 400
INVALID_INPUT: 400
INVALID_API_KEY: 401
PLAN_UPGRADE_REQUIRED: 403
FORBIDDEN: 403
NOT_FOUND: 404
CONFLICT: 409
PAYLOAD_TOO_LARGE: 413
UNSUPPORTED_MEDIA_TYPE: 415
RATE_LIMIT_EXCEEDED: 429
DATABASE_UNAVAILABLE: 503
INTERNAL_ERROR: 500

Novos domínios · Alertas

Os domínios vêm de agregados públicos reais. Primeira observação não é data de registo. Os alertas pertencem ao titular da chave.

limit: 1–200 · page: 1–10,000 · since: ISO 8601 · unread: true/false