Skip to Content
مرجع APIالمصادقة

المصادقة

يوجد SupDesk API على:

https://api.supdesk.app/v1

كل طلب مُصادَق عليه بـ مفتاح API يُرسَل كأسلوب Bearer:

curl https://api.supdesk.app/v1/submissions \ -H "Authorization: Bearer sd_live_..."

إنشاء مفتاح

أنشئ المفاتيح في وحدة التحكّم تحت إعدادات مساحة العمل ← مفاتيح API. كل مفتاح:

  • محصور بمشروع واحد — فكل ما تقرأه أو تكتبه من خلاله يخصّ ذلك المشروع؛
  • يبدأ ببادئة يمكن تمييزها مثل sd_live_، فتستطيع التعرّف على المفاتيح في ملفات التكوين دون كشفها؛
  • يُعرض مرة واحدة عند الإنشاء. ولا تخزّن SupDesk سوى تجزئة للمفتاح — فإن فقدته، ألغِه وأنشئ واحدًا جديدًا.

التعامل مع المفاتيح

تعامل مع مفاتيح API كما تتعامل مع كلمات المرور. استدعِ الـ API من خوادمك فقط — فالـ API لا يدعم CORS، وهذا مقصود، حتى لا تكون المفاتيح قابلة للاستخدام من المتصفحات. وإن تسرّب مفتاح، ألغِه في وحدة التحكّم؛ ويسري الإلغاء فورًا.

فشل المصادقة

المفتاح المفقود أو المشوّه أو الملغى أو غير المعروف يُنتج دائمًا الاستجابة نفسها، حتى لا يتمكّن المستدعون من استكشاف المفاتيح الموجودة:

{ "error": { "code": "unauthorized", "message": "Invalid or missing API key." } }

القراءة مقابل الكتابة

جميع الخطط تستطيع القراءة عبر الـ API. أما نقاط نهاية الكتابة (POST، PATCH، DELETE) فتتطلّب أن تكون مساحة العمل على خطة مدفوعة Pro — وفي Free، تُعيد عمليات الكتابة خطأ 403 forbidden. راجع حدود المعدل والاستخدام.

Last updated on