Waafir
هذه الصفحة ترجمة آلية في انتظار المراجعة البشرية. قد تحتوي على أخطاء.

واجهة API للمنصة (/v1)

واجهة API للمنصة هي واجهة HTTP ذات الإصدارات في Waafir. استخدمها لقراءة بيانات مؤسستك وإدارتها من أنظمتك الخاصة. وهي تغطي فريقك (دعوة الأعضاء، وتغيير الأدوار، وإزالتهم)، ومنح الوصول على غرف البيانات، والمجلدات، والملفات، والأسئلة والأجوبة، ومحادثة غرفة البيانات والوكلاء، والنشاط والتفاعل لكل طرف مقابل، ومراقبة المحافظ.

وهي واجهة منفصلة عن خوادم MCP في Waafir، التي تعرض المنصة نفسها لعملاء الذكاء الاصطناعي بوصفها أدوات. وتستخدم كلتاهما في المصادقة رموز الوصول الشخصية نفسها.

عنوان URL الأساسي

تقع كل نقطة نهاية تحت:

https://app.waafir.io/api/v1

يسرد مرجع نقاط النهاية كلًّا منها بمساره الكامل، مثل GET /api/v1/team.

أول طلب لك

  1. أصدر رمزًا. في Waafir، افتح الإضافات ← الإعدادات وأصدر رمز وصول شخصيًا. ويكفي رمز read للبدء. انسخ القيمة، التي تبدأ بـ waafir_pat_. ولا تُعرض إلا مرة واحدة.
  2. اسأل من أنت. يعيد GET /api/v1/session الهوية والمؤسسة اللتين يعمل الرمز باسمهما. استخدمه للتأكد من أن الرمز يعمل قبل أن تبني عليه:
curl -s https://app.waafir.io/api/v1/session \
  -H "Authorization: Bearer $WAAFIR_TOKEN"
{
  "orgId": "…",
  "userId": "…",
  "email": "you@example.com",
  "orgRole": "admin",
  "authMethod": "pat",
  "principalType": "user"
}

يعني الرمز 401 أن الرمز مفقود، أو مكتوب بشكل خاطئ، أو منتهي الصلاحية، أو ملغى. وعادةً ما تحمل حالات الرفض الأخرى code قابلًا للقراءة آليًا، مشروحًا في صفحة رموز الأخطاء. وبعضها لا يحمل أي رمز، لذا ارجع دائمًا إلى حالة HTTP.

كيف يُبنى المرجع

صفحتا نقاط النهاية ورموز الأخطاء مُولَّدتان من شجرة المسارات الخاصة بالمنصة في كل مرة يُنشر فيها هذا الموقع. فهما لا تُكتبان يدويًا. ويبنيهما إصدار الإنتاج من الإيداع نفسه الذي يُبنى منه التطبيق، فتسردان المسارات التي يقدّمها ذلك الإصدار، مع قيد الدور ونطاق الرمز اللذين تتطلبهما كل نقطة نهاية ومعاملات الاستعلام التي تقبلها. وقوائم الأخطاء فيهما حدّ أدنى معروف، لا قائمة شاملة: فقد تُرجع نقطة النهاية رموزًا لا يستطيع المولّد رؤيتها، لذا تعامل مع الأخطاء غير المدرجة وفق حالة HTTP.

الإصدارات

الإصدار /v1 إضافي ضمن إصداره. فقد تضيف Waafir حقولًا إلى الاستجابات ومعاملات اختيارية إلى الطلبات. لكنها لا تزيل حقلًا قائمًا ولا تغيّر نوعه، ولا تزيل نقطة نهاية، ضمن /v1. ويُطرح أي تغيير كاسر تحت بادئة إصدار جديدة. اكتب عملاء يتجاهلون الحقول التي لا يتعرّفون عليها.

إلى أين تذهب بعد ذلك