المصادقة
كيفية مصادقة طلبات الواجهة باستخدام مفاتيح API.
مفاتيح API
تستخدم واجهة eWasl مفاتيح API لمصادقة الطلبات. كل مفتاح محكوم بصلاحيات محدّدة ويمكن إلغاؤه باستقلالية.
تتبع المفاتيح الصيغة ewasl_ متبوعةً بسلسلة عشوائية. وتُعرض مرة واحدة فقط عند الإنشاء —
فاحفظها بأمان.
إنشاء مفتاح API
- سجّل الدخول إلى حساب eWasl.
- انتقل إلى Settings ← API Keys.
- اضغط Create New Key.
- أعطِ المفتاح اسماً وصفياً (مثل "Production App" أو "CI Pipeline" أو "MCP Integration").
- اختر الصلاحيات التي يحتاجها مفتاحك (
posts:read،posts:create). - انسخ المفتاح المُولّد فوراً — لن يُعرض مرة أخرى.
يمكنك أيضاً إنشاء المفاتيح برمجياً عبر نقطة إنشاء مفتاح.
استخدام مفتاح API
ضمّن المفتاح في ترويسة Authorization لكل طلب باستخدام مخطط Bearer:
مثال: عرض المنشورات
مثال: إنشاء منشور
اختيار مساحة العمل
تستخدم نقاط المنشورات افتراضياً مساحة العمل الشخصية لمالك بيانات اعتماد API. لتنفيذ
الطلب داخل مساحة عمل مشتركة، أرسل معرّفها UUID في الترويسة
x-ewasl-workspace-id:
لا تمنح هذه الترويسة الوصول وحدها. تتحقق eWasl في كل طلب من العضوية الحالية، وحالة
مساحة العمل، وصلاحيات الدور، والعلامات التجارية المعيّنة، واستحقاق مالك المساحة. يعيد
المعرّف غير الصالح 400، بينما يعيد الوصول الملغى أو غير الكافي 403. لا ينبغي
إعادة محاولة أي منهما تلقائياً في مساحة عمل أخرى.
الصلاحيات
كل مفتاح محكوم بصلاحيات محدّدة. لن تنجح إلا العمليات التي تغطّيها صلاحيات المفتاح.
| الصلاحية | الوصف | مطلوبة لـ |
|---|---|---|
posts:read | قراءة بيانات المنشورات | GET /api/v1/posts، GET /api/v1/connections |
posts:create | إنشاء ونشر المنشورات | POST /api/v1/posts، POST /api/v1/posts/schedule |
إن افتقر المفتاح إلى الصلاحية المطلوبة، تعيد الواجهة خطأ 403 Forbidden:
استجابات الأخطاء
| حالة HTTP | رمز الخطأ | المعنى |
|---|---|---|
| 401 | UNAUTHORIZED | لا مفتاح، أو المفتاح غير صالح/منتهٍ |
| 400 | WORKSPACE_SELECTION_INVALID | معرّف UUID لمساحة العمل غير صالح |
| 403 | FORBIDDEN | المفتاح صالح لكنه يفتقر إلى الصلاحية المطلوبة |
| 403 | WORKSPACE_ACCESS_REVOKED | العضوية أو الوصول إلى مساحة العمل لم يعد صالحاً |
| 503 | WORKSPACE_UNAVAILABLE | تعذّر التحقق من صلاحية مساحة العمل بأمان |
| 429 | RATE_LIMITED | طلبات كثيرة — انتظر وأعِد المحاولة |
مثال استجابة 401
أفضل ممارسات الأمان
- احفظ المفاتيح سرّيةً — لا تضع مفاتيح API في إدارة الإصدارات ولا تكشفها في جافاسكربت العميل. استخدم متغيّرات البيئة.
- أقل امتياز ممكن — امنح فقط الصلاحيات التي يحتاجها تطبيقك فعلاً.
- دوّر المفاتيح دورياً — ألغِ القديمة وأنشئ جديدة بانتظام، خصوصاً بعد تغيّر أعضاء الفريق.
- افصل المفاتيح — أنشئ مفاتيح مختلفة للبيئات المختلفة (تطوير، تجريب، إنتاج) وللتطبيقات المختلفة.
- راقب الاستخدام — تحقّق من طابع
last_used_atعلى مفاتيحك في اللوحة لاكتشاف أي استخدام غير مصرّح. - ألغِ المفاتيح المسرّبة — إن تسرّب مفتاح، ألغِه فوراً من اللوحة أو عبر نقطة إلغاء مفتاح.