توثيق API

أنشئ تكاملات آمنة مع LeakData

تحقق من انكشاف البيانات في الاختراقات، واحمِ المستخدمين، وتلقَّ تنبيهات أمنية عبر API الخاص بـ LeakData.

قبل طلبك الأول

يتطلب الوصول إلى واجهة برمجة التطبيقات خطة Enterprise مع تفعيل الوصول إلى الواجهة. أنشئ مفتاحًا في لوحة التحكم وحدد فقط نطاقات الصلاحيات التي يحتاج إليها تكاملك.

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

ما الذي تريد فعله؟

اختر هدفًا وانتقل مباشرةً إلى نقطة النهاية والإرشادات الأمنية ومثال التنفيذ ذات الصلة.

البدء السريعطلبك الأول في 3 خطوات

أقصر مسار للتنفيذ، من المصادقة إلى إرسال طلب صالح.

  1. 1

    إجراء المصادقة

    أرسل مفتاح API في ترويسة Bearer مع كل طلب.

    Authorization: Bearer YOUR_API_KEY
  2. 2

    إرسال طلب تجريبي

    عيّن LEAKDATA_API_KEY إلى مفتاح API الخاص بك، ثم أرسل طلب POST للبحث عن انكشاف البيانات.

  3. 3

    معالجة الاستجابة

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

فهرس نقاط النهاية

مرجع API

استعرض نقاط النهاية المنشورة للإصدار v1 سريعًا وافتح القسم التفصيلي.

مواصفات OpenAPI

مقدمة

يتيح لك API الخاص بـ LeakData.io إضافة فحوصات اختراق البيانات والمراقبة الأمنية إلى سير عملك عبر واجهة REST.

عنوان URL الأساسي: https://leakdata.io/api/v1

الإمكانات

  • البحث عن مؤشرات انكشاف البيانات ضمن بيانات الاختراق المفهرسة
  • استخدام نقطة نهاية موحدة للبحث لفحص البريد الإلكتروني ورقم الهاتف واسم المستخدم والنطاق
  • إنشاء مفاتيح API من لوحة التحكم
  • استخدام وصول المؤسسات إلى API وخطافات الويب للتكاملات المُدارة
  • إرسال حمولات SIEM/SOAR موقّعة إلى Splunk وElastic وSentinel والبرمجيات الوسيطة لـ CEF/Syslog

المصادقة

تستخدم طلبات API مفتاح API. يمكنك إنشاء المفاتيح وإدارتها من لوحة التحكم.

ترويسات الطلب
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
تحذير أمني: لا تكشف مفاتيح API أبدًا في التعليمات البرمجية من جانب العميل أو في المستودعات العامة.

حدود معدل الطلبات

يُقدَّم الوصول إلى API حاليًا ضمن باقات تكامل المؤسسات. لا تتضمن خطط الخدمة الذاتية حصة لاستخدام API العام.

الخطةفي الدقيقةيوميًاشهريًا
Free——غير مشمول
Pro / Elite——غير مشمول
Enterpriseحسب العقدحسب العقدحسب العقد

النطاقات الخاضعة للمراقبة

اعرض سجلات مراقبة النطاقات المتاحة لمالك مفتاح API المستخدَم للمصادقة.

GET/domains

الاستجابة

JSON
{
  "success": true,
  "count": 1,
  "domains": [{
    "id": "domain_123",
    "domain": "example.com",
    "verified": true,
    "status": "active",
    "vulnerabilities": 0,
    "alerts": 0
  }],
  "timestamp": "2026-08-08T00:00:00.000Z"
}

أمان كلمات المرور باستخدام k-anonymity

افحص بادئة تجزئة كلمة المرور دون إرسال كلمة المرور أو قيمة تجزئتها الكاملة.

أرسل أول خمسة محارف فقط من قيمة تجزئة SHA-1 المكتوبة بأحرف كبيرة. لا يتلقى LeakData مطلقًا كلمة المرور الأصلية أو قيمة التجزئة الكاملة.
GET/password/check/5BAA6

الاستجابة

{
  "hashes": {
    "1E4C9B93F3F0682250B6CF8331B7EE68FD8": 12345,
    "ABCDEF0123456789ABCDEF0123456789ABC": 6789
  }
}

التنبيهات

اعرض التنبيهات الأمنية للمستخدم الذي تمت مصادقته.

GET/alerts

معلمات الاستعلام

  • limit - الحد الأقصى للسجلات المُرجعة (الافتراضي: 10، الحد الأقصى: 100)
  • status - مرشح الحالة (read, unread, all)
  • severity - مرشح مستوى الخطورة (low, medium, high, critical)

أمثلة التعليمات البرمجية

JavaScript (Node.js)
const axios = require('axios');

async function checkEmail(email) {
  try {
    const response = await axios.post(
      'https://leakdata.io/api/v1/search',
      { type: 'email', query: email },
      {
        headers: {
          'Authorization': 'Bearer YOUR_API_KEY',
          'Content-Type': 'application/json'
        }
      }
    );

    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

checkEmail('user@example.com');

رموز الأخطاء

الرمزالوصف
400طلب غير صالح - معلمات الطلب غير صالحة
401غير مصادق عليه - مفتاح API غير صالح أو مفقود
403محظور - تم رفض الوصول
429طلبات كثيرة جدًا - تم تجاوز حد معدل الطلبات
500خطأ داخلي في الخادم - خطأ في الخادم

Webhooks

تلقَّ إشعارات تلقائية عند اكتشاف مؤشرات جديدة على تسريبات بيانات.

اضبط عنوان URL لخطاف الويب والإعداد المسبق للحمولة من لوحة التحكم. يرسل LeakData طلبات POST موقّعة ويحتفظ بسجلات عمليات الإرسال الفاشلة القابلة لإعادة المحاولة للمتابعة التشغيلية.

ترويسات الإرسال

X-Webhook-Signature
توقيع HMAC-SHA256 يُولَّد من محتوى JSON الخام باستخدام سر خطاف الويب.
X-LeakData-Signature
صيغة توقيع sha256= متوافقة مع أدوات SIEM/SOAR.
X-LeakData-Event-Id
معرّف حدث ثابت لربط الأحداث وتتبع إعادة المحاولة.
X-LeakData-Payload-Preset
صيغة الحمولة المحددة، مثل splunk_hec أو elastic_ecs أو microsoft_sentinel.
X-Webhook-Attempt
رقم محاولة التسليم للمستقبِلات التي تراعي إعادة المحاولة.

حمولة عامة

{
  "id": "evt_9f3a7c2e6b1d4a80",
  "type": "domain.alert",
  "created": 1770000000000,
  "data": {
    "domain": "example.com",
    "severity": "high",
    "breachCount": 2
  }
}

SIEM/SOAR

يمكن إرسال خطافات الويب في خطة Enterprise بالتنسيق الذي تتوقعه منظومتك الأمنية. يغيّر الإعداد المسبق المحدد محتوى JSON المرسل ويضيف ترويسات للتوافق.

LeakData JSON

generic

حمولة JSON موقّعة افتراضية. تظل جميع حقول الأحداث ضمن مخطط LeakData.

الوجهة
مستقبِلات خطافات ويب مخصصة، وأدلة إجراءات SOAR
الترويسة
X-LeakData-Payload-Preset

Splunk HEC

splunk_hec

تُرسل مع الحقول time وsource وsourcetype وevent وfields إلى Splunk HTTP Event Collector.

الوجهة
Splunk HTTP Event Collector
الترويسة
X-Splunk-Request-Channel

Elastic ECS

elastic_ecs

تستخدم الحقول event وobserver وthreat وrule وleakdata بصيغة شبيهة بـ ECS لاستيعاب البيانات في Elastic.

الوجهة
استيعاب البيانات في Elastic ECS
الترويسة
X-Elastic-Event-Dataset

Microsoft Sentinel

microsoft_sentinel

تستخدم الحقول TimeGenerated وEventId وEventType وSeverity وRawData للجداول المخصصة في Log Analytics.

الوجهة
سجل مخصص في Microsoft Sentinel
الترويسة
Log-Type

CEF / Syslog

cef_syslog

تتضمن رسالة متوافقة مع CEF داخل JSON للبرمجيات الوسيطة الخاصة بـ syslog أو SOAR.

الوجهة
برمجيات وسيطة لـ CEF أو Syslog أو SOAR
الترويسة
X-CEF-Product

Splunk HEC

{
  "time": 1770000000,
  "source": "leakdata",
  "sourcetype": "leakdata:webhook",
  "event": {
    "id": "evt_splunk",
    "type": "webhook.test",
    "created": 1770000000000,
    "data": {
      "message": "LeakData webhook test notification"
    }
  },
  "fields": {
    "leakdata_event_id": "evt_splunk",
    "leakdata_event_type": "webhook.test",
    "leakdata_preset": "splunk_hec"
  }
}

Microsoft Sentinel

{
  "TimeGenerated": "2026-02-02T02:40:00.000Z",
  "EventId": "evt_sentinel",
  "EventType": "webhook.test",
  "SourceSystem": "LeakData",
  "Severity": 3,
  "RawData": {
    "id": "evt_sentinel",
    "type": "webhook.test",
    "created": 1770000000000,
    "data": {
      "message": "LeakData webhook test notification"
    }
  }
}

أحداث خطاف الويب

اختر نوع حدث واحدًا أو أكثر عند إنشاء خطاف ويب. تستخدم عمليات الإرسال التجريبية webhook.test، بينما تستخدم عمليات الإرسال الفعلية أسماء الأحداث المحددة أدناه.

breach.detectedاكتشاف تطابق في بيانات اختراقظهور معرّف خاضع للمراقبة في بيانات اختراق.
breach.newسجل اختراق بيانات جديدإضافة اختراق بيانات جديد إلى مجموعة بيانات LeakData.
domain.alertتنبيه نطاقظهور مؤشر خطر مرتبط بنطاق شركة خاضع للمراقبة.
search.foundالعثور على نتيجة بحثإرجاع تطابق من بحث عبر API أو سير عمل للمراقبة.
monitoring.alertتنبيه مراقبةصدور تنبيه من مراقبة بريد إلكتروني أو نطاق أو حساب.
account.suspiciousحدث مريب في الحساباكتشاف حدث أمني غير معتاد في الحساب.
api.limit.warningتحذير بشأن حد APIاقتراب استخدام API للمؤسسات من عتبة مهمة.
easm.inventory.changedتغيّر جرد EASMرصد تغييرات في جرد نطاق تم التحقق منه: أصول جديدة وأصول اختفت وأصول تغيّرت. لا يتضمن مستوى خطورة.
easm.finding.openedفتح نتيجة أمنية في EASMنتيجة أمنية مدعومة بالأدلة، جديدة أو أُعيد فتحها، تتضمن النطاق واسم المضيف وIP والمنفذ والضابط الأمني ومستوى الخطورة والفئة والمصدر. بالنسبة إلى النتيجة الأمنية التي تستدعي إجراءً، تتطابق priority (urgent, high, normal, low) وpriorityReasons (knownExploitation, exploitLikelihood, criticalAsset, highSeverity) مع لوحة التحكم. تكون قيمة kev هي true عندما يكون CVE الخاص بنتيجة أمنية مؤكدة مدرجًا في كتالوج CISA KEV، وتكون false عندما لا يكون أي من معرّفات CVE الخاصة بها مدرجًا فيه؛ ويُحذف الحقل عندما يكون قد مضى أكثر من 48 ساعة على فحص KEV أو عندما تكون النتيجة الأمنية غير مؤكدة. تُرسل أحداث EASM بغض النظر عن التفضيل الشخصي لتلقي إشعارات الحالات الحرجة فقط.
easm.finding.resolvedمعالجة نتيجة أمنية في EASMنتيجة أمنية يثبت رصد جديد أنها عولجت. تتضمن kev وفق القاعدة نفسها، دون priority.