HelpFraud · وثائق المطورين

اربط خادمك بواجهة HelpFraud Business API.

Authorization · BUSINESS

أرسل Authorization: Bearer hf_live_example. هذا ليس مفتاحًا حقيقيًا. احتفظ بالمفاتيح على خادمك، وليس في المتصفح أو الروابط.

تُصادق المفاتيح طلباتك إلى واجهة HelpFraud البرمجية. يُعرض المفتاح الكامل مرة واحدة فقط.

‏4.99 US$ / شهريًا

فحوصاتك

استخدم input وtype الاختياري. تختار نقاط النهاية المخصصة محللها. النتائج مؤشرات مخاطر وليست دليل احتيال؛ لا توجد جهات خارجية متصلة.

تقبل Bulk من 1 إلى 50 عنصر. يستهلك كل عنصر وحدة API شهرية. تُعاد الأخطاء لكل عنصر. الحد الأقصى للطلب 256 KiB.

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'

حد المعدّل

Business: 60 وحدة لكل دقيقة متحركة و5,000 وحدة لكل شهر تقويمي. الأخطاء: error.code وerror.message وerror.request_id. يتضمن 429 الحقل 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

نطاقات جديدة · التنبيهات

النطاقات من بيانات عامة حقيقية ومجمعة. أول رصد ليس تاريخ التسجيل. التنبيهات تخص مالك المفتاح فقط.

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