كيفية استخدام واجهة برمجة التطبيقات العامة الخاصة بمنصتنا

في هذه المقالة، سوف تتعلم كيفية تكوين واستخدام واجهة برمجة التطبيقات العامة في منصتنا، بما في ذلك كيفية إنشاء مفاتيح واجهة برمجة التطبيقات وما هي الإجراءات التي يمكن القيام بها

أولًا: ما هي واجهة برمجة التطبيقات؟

يشير الاختصار واجهة برمجة التطبيقات إلى "واجهة برمجة التطبيقات"، وهي سلسلة من التعليمات التي تقدم من خلالها المنصة خدماتها لمنصات أخرى. إنها بوابة استراتيجية تتيح للمطورين الخارجيين الوصول إلى وظائف أو بيانات معينة من المنصة بشكل منظم وآمن. إنها كأدوات جاهزة للاستخدام تجعل من السهل بناء تطبيقات أو خدمات أو تركيبات جديدة

باختصار، تفتح منصتنا أمام المنصات الأخرى لتقديم خدماتها حيث تضيف قيمة

ثانيًا: كيف تعمل واجهة برمجة التطبيقات العامة الخاصة بنا؟

تقوم واجهة برمجة التطبيقات الخاصة بنا بتقديم مجموعة من الميزات المختارة بعناية، مما يتيح للمطورين التفاعل مع منصتنا بشفافية وكفاءة. إذا كنت ترغب في معرفة المزيد عن كيفية عملها، يمكنك قراءة الوثائق الرسمية لواجهة برمجة التطبيقات

ثالثًا: كيفية إنشاء مفاتيح واجهة برمجة التطبيقات الخاصة بك

مفاتيح واجهة برمجة التطبيقات هي معرفات فريدة تصادق الطلبات إلى واجهة برمجة التطبيقات العامة الخاصة بنا. تمكنك من الوصول برمجيًا إلى الموارد المختلفة على منصتنا وإدارتها

لإنشاء مفتاح واجهة برمجة التطبيقات عام، اضغط على صورة ملفك الشخصي، اختر الإعدادات (1)، ثم مرر لأسفل إلى

(2) API و MCP مفاتيح

اضغط على إنشاء (3) لبدء إنشاء مفتاح واجهة برمجة التطبيقات عام

في نافذة إنشاء مفتاح واجهة برمجة التطبيقات العام، أدخل اسمًا، وحدد تاريخ ووقت انتهاء صلاحية لمفتاح واجهة برمجة التطبيقات الخاص بك

عند الانتهاء، اضغط على حفظ (4)

المفتاح الخاص بك جاهز الآن

رابعًا: ماذا يمكنك أن تفعل بواجهة برمجة التطبيقات الخاصة بنا؟

واجهتنا تفتح بعض الإمكانيات المثيرة. فيما يلي الإجراءات الرئيسية التي يمكنك القيام بها باستخدام واجهة برمجة التطبيقات العامة لدينا

:أ. جهات الاتصال، العلامات، والحقول المخصصة

ـ إدارة جهات الاتصال: إنشاء جهات اتصال جديدة، تحديث جهات الاتصال الحالية، عرض قائمة جمهورك باستخدام فلاتر متقدمة، أو حذف جهات الاتصال

ـ إدارة العلامات: إنشاء، تعيين، عرض، وإزالة العلامات من جهات الاتصال

ـ الحقول المخصصة: الحصول على الحقول المخصصة المتاحة لجهة الاتصال ومعرفاتها لملء معلومات جهة الاتصال بشكل صحيح

:ب. الرسائل الإخبارية

ـ إنشاء وتحديث الرسائل الإخبارية: إنشاء مسودات رسائل إخبارية جديدة أو تحديث الرسائل الحالية جزئيًا. يمكنك تحديد نوع المحرر (كلاسيكي أو بصري)، تعيين اسم المرسل وعنوان بريده بشكل صريح، واسترجاع محتوى

بالكامل HTML

ـ قائمة واسترجاع: تصفح الرسائل الإخبارية الموجودة لديك أو الحصول على المحتوى الكامل لرسالة إخبارية معينة باستخدام معرفها

:ج. المسارات ومحرر الصفحات

ـ إدارة المسارات: إنشاء مسارات جديدة، إضافة خطوات جديدة (صفحات) لها، والحصول على قائمة بجميع الخطوات الفردية داخل مسار معين

ـ محرر الصفحات: حفظ محتوى صفحات المنشأة مباشرة إلى خطوات المسار أو صفحات الموقع الإلكتروني (استبدال

كامل)، والحصول على مخططات

لنماذج صفحات محددة JSON

:د. خطط الأسعار والكوبونات

ـ إنشاء، تحرير، وحذف: إنشاء خطط أسعار وكوبونات جديدة، أو تحديثها جزئيًا وحذفها

ـ عرض والبحث: تصفح جميع خطط الأسعار والكوبونات الحالية لديك، أو الحصول على عناصر معينة بواسطة معرفها

:هـ. الدورات والطلاب

ـ إدارة الدورات والطلاب: الحصول على قائمة الدورات الحالية واسترجاع قائمة الطلاب المسجلين حاليًا

ـ تسجيل الطلاب: تسجيل جهات الاتصال برمجيًا في دوراتك الفردية

:و. المجتمعات

ـ إدارة المجتمعات: استرجاع قائمة المجتمعات الحالية لديك، والوصول إلى قائمة الأعضاء الحاليين داخل مجتمع محدد

ـ دعوة الأعضاء: دعوة مستخدمين جدد للانضمام إلى مجتمعاتك برمجيًا عن طريق تقديم معرف جهة الاتصال الخاص بهم

:ز. قواعد التشغيل الآلي

ـ إدارة القواعد: ربط الأحداث الشائعة والإجراءات برمجيًا، تحديث القواعد الحالية مثل تغيير إجراء بينما يتم الاحتفاظ بالمشغل نفسه، أو حذف القواعد برفق

ـ عرض واسترجاع: تصفح قواعد التشغيل الآلي الخاصة بك أو الحصول على قاعدة معينة بواسطة معرفها

:ح. الاشتراكات

ـ إدارة الاشتراكات: استرجاع قائمة بجميع الموارد في اشتراك من منصات الطرف الثالث، وإلغاء الاشتراك إما فورًا أو في نهاية دورة الفواتير

ط. نقاط التوزيع (ويب هوكس)

ـ إدارة نقاط التوزيع: إنشاء نقاط توزيع جديدة برمجيًا لتلقي إشعارات في الوقت الفعلي، استرجاع قوائم نقاط التوزيع الحالية، وإزالة نقاط التوزيع غير المطلوبة

تعرف على المزيد: الوثائق الخاصة بواجهة برمجة التطبيقات