دليل المطورين

اربط برنامجك بمكتبة بيّنة: ترسل سؤالًا، فترجع لك أقرب المقاطع من المصادر مع مرجع كل مقطع ورابطه الرسمي. الربط البرمجي للمشتركين؛ أنشئ مفتاحك من حسابي.

المصادقة

كل طلب يحمل المفتاح في الترويسة Authorization. المفتاح يبدأ بـ bay_live_ ويُعرض مرة واحدة عند إنشائه.

Authorization: Bearer bay_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

البحث

POST https://bayenah.digitelz.com/v1/search

curl -X POST https://bayenah.digitelz.com/v1/search \
  -H "Authorization: Bearer $BAYENAH_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"اشتراطات محلات العصائر","limit":3,"kinds":["regulation"]}'

الرد:

{
  "status": "ok",
  "data": [
    {
      "text": "…نص المقطع كما في المصدر…",
      "kind": "regulation",
      "citation": {
        "source": "الأنظمة واللوائح والاشتراطات البلدية (وزارة البلديات والإسكان)",
        "publisher": "وزارة البلديات والإسكان",
        "place": "اشتراطات محلات العصائر، صفحة 4",
        "url": "https://momah.gov.sa/…",
        "year": null
      }
    }
  ],
  "meta": { "request_id": "req_…", "remaining": 182 }
}

إن لم تجد المكتبة مصدرًا قريبًا من السؤال يرجع "status": "not_available" و"data": []، ولا يُحسب الطلب من باقتك.

الاستهلاك

GET https://bayenah.digitelz.com/v1/usage يرجع حدك والمستخدم والمتبقي في فترتك.

{ "status": "ok", "data": { "limit": 200, "used": 18, "remaining": 182, "period_end": "2026-11-14T09:00:00.000Z" } }

الأخطاء

شكل الخطأ: { "status": "error", "error": { "code", "message_ar", "message_en", "request_id" } }

الموصل (MCP)

للمساعدات الذكية: https://bayenah.digitelz.com/mcp بنقل Streamable HTTP ودخول OAuth 2.1. الأدوات: search_saudi_library وlibrary_sources. الطريقة خطوة بخطوة في حسابي.

قواعد الاستخدام

• اذكر المصدر لمستخدميك كما يصلك في citation.
• لا تُعِد بيع نصوص المكتبة أو نشرها جملة.
• المفتاح شخصي؛ ألغِه فورًا إن انكشف وأنشئ غيره.