تخطَّ إلى المحتوى
المحتويات
المرجع

OpenAPI وأدوات الذكاء الاصطناعي

وصف مقروء آليا لهذه الـ API، على رابط ثابت، لمولّدات الكود ومستكشفات الـ API وأدوات البرمجة الذكية. وإلى جانبه خريطة نصية موجزة للموقع تخاطب الوكلاء.

رابطان ثابتان

كلاهما خارج بادئة اللغة، لأن المولّد والوكيل يريدان عنوانا واحدا لا يتحرك بلغة القارئ.

الرابط
https://whats.azzamkh.sa/openapi.json
https://whats.azzamkh.sa/llms.txt

افتح مستند OpenAPI أو خريطة الموقع للوكلاء مباشرة.

ماذا يغطي

المستند دقيق فيما يصفه، وهو يصف ما هو موجود.

  • المصادقة، والرسائل، والقنوات، والـ Sandbox، والـ QR، وجهات الاتصال، والمجموعات، والوسوم، والقوالب، والمحادثات، والـ webhooks، والاستهلاك، والخطة، وفحصي الصحة.
  • سطح إدارة المنصة ونداء مزوّد الـ Sandbox خارج النطاق: فهما لا يحملان وعد توافق للعملاء.
  • المستند مكتوب يدويا من متحكمات الـ API ومخططاتها لا مولَّدا، لأن الـ backend لا مولّد فيه ليُشغَّل.
  • لا يظهر فيه ما ليس موجودا. لا مسارات حملات ولا أتمتة ولا تسجيل Meta ولا إرسال وسائط — فالمسار الذي يعطي 404 أسوأ من المسار الغائب في مستند يقرؤه مولّد.

دقيق لا شامل

حيث يُختصر مخطط فهو مختصر بصدق، لكن غياب خاصية من المستند ليس دليلا على أن الـ API ترفضها. وحين يختلف الاثنان فالـ API هي الصواب — ويستحق ذلك التبليغ.

استعماله

المستند بصيغة OpenAPI 3.1 ويُقدَّم بسياسة CORS متساهلة، فتستطيع أداة تعمل في المتصفح جلبه مباشرة.

  • وجّه مولّد عميل إلى الرابط لتحصل على عميل مكتوب الأنواع بلغتك.
  • استورد الرابط تعريفَ OpenAPI لتحصل على مجموعة جاهزة.
  • أي عارض OpenAPI سيصيّره. وصيغة الأمان bearerAuth معلنة، فسيطلب العارض بيانات الاعتماد على الوجه الصحيح.

لا توجد SDKs رسمية بعد

لم تُنشر أي منها، فلم يُربط بأي منها. والعميل المولَّد من هذا المستند هو المسار المدعوم اليوم.

لأدوات البرمجة الذكية

أعطِ الوكيل الرابطين واسم متغيّر البيئة، فيستطيع تكوين طلبات صحيحة دون قراءة أي مصدر. وهذا prompt يعمل:

prompt
Use the WhatsApp messaging API at https://whats.azzamkh.sa/api.
Read https://whats.azzamkh.sa/llms.txt and https://whats.azzamkh.sa/openapi.json first.
Authenticate with "Authorization: Bearer $WA_API_KEY" — read the key
from the environment, never write it into a file.
Send an order confirmation with the order_confirmation template.

لا تلصق مفتاحا في الكود أبدا

اطلب من الوكيل قراءة المفتاح من بيئة التشغيل. فالمفتاح المكتوب في ملف مفتاح ينتهي في نظام إصدارات، ولن يعرض هذا التوثيق أبدا مفتاحا يُلصق في كود.