Loading
في هذه المقالة، سوف تتعلم كيفية تكوين واستخدام واجهة برمجة التطبيقات العامة في systeme.io، بما في ذلك كيفية إنشاء مفاتيح API وما هي الإجراءات التي يمكن القيام بها.
1. ما هو API؟
يشير الاختصار API إلى "واجهة برمجة التطبيقات"، وهي سلسلة من التعليمات التي تقدم من خلالها منصة خدماتها لمنصات أخرى. إنها بوابة استراتيجية تتيح للمطورين الخارجيين الوصول إلى وظائف أو بيانات معينة من المنصة بشكل منظم وآمن. إنها كأدوات جاهزة للاستخدام تجعل من السهل بناء تطبيقات أو خدمات أو تركيبات جديدة.
باختصار، يفتح systeme.io أمام المنصات الأخرى لتقديم خدماتها حيث تضيف قيمة.
2. كيف تعمل واجهة برمجة التطبيقات العامة الخاصة بنا؟
تقوم واجهة برمجة التطبيقات الخاصة بنا بتقديم مجموعة من الميزات المختارة بعناية، مما يتيح للمطورين التفاعل مع منصتنا بشفافية وكفاءة. إذا كنت ترغب في معرفة المزيد عن كيفية عملها، يمكنك قراءة الوثائق الرسمية لواجهة برمجة التطبيقات.
3. كيفية إنشاء مفاتيح API الخاصة بك
مفاتيح API هي معرفات فريدة تصادق الطلبات إلى واجهة برمجة التطبيقات العامة الخاصة بنا. تمكنك من الوصول برمجيًا إلى الموارد المختلفة على منصتنا وإدارتها.
لإجراء تكامل خارجي، تحتاج أولاً إلى إنشاء مفتاح API آمن. اضغط على صورة ملفك الشخصي واختر الإعدادات (1). في القائمة اليسرى، اضغط على MCP & API keys (2).
مرر إلى أسفل قسم مفاتيح API العامة واضغط على إنشاء (3).
أعط مفتاحك اسمًا، حدد تاريخ انتهاء صلاحية واضغط على حفظ (4).
ملاحظة: لكي يبقى مفتاح API الخاص بك نشطًا إلى أجل غير مسمى، اترك حقل 'انتهاء الصلاحية' فارغًا.
المفتاح الخاص بك جاهز الآن.
4. ماذا يمكنك أن تفعل بواجهة برمجة التطبيقات الخاصة بنا؟
يتيح API لدينا بعض الإمكانيات المثيرة. فيما يلي الإجراءات الرئيسية التي يمكنك القيام بها باستخدام واجهة برمجة التطبيقات العامة لدينا:
أ. إدارة جهات الاتصال، العلامات، والحقول المخصصة:
جهات الاتصال: إنشاء جهات اتصال جديدة، تحديث الموجودة، عرض الجمهور باستخدام فلاتر متقدمة، أو حذف جهات الاتصال.
العلامات: إنشاء، تعيين، عرض، وإزالة العلامات من جهات الاتصال.
الحقول المخصصة: استرجاع الحقول المخصصة المتاحة لجهات الاتصال ومعرفاتها (slugs) لملء المعلومات بشكل صحيح.
ب. إدارة النشرات الإخبارية والحملات:
الرسائل الإخبارية: إنشاء مسودات جديدة، تحديث الموجودة، استهداف الجمهور (باستخدام تضمين/استبعاد العلامات)، إعداد تفاصيل المرسل، جدولة الرسائل أو إلغائها، إرسال اختبارات، إرسال رسالة مباشرة، حذف مسودات، واسترجاع رسائل معينة.
الحملات: إنشاء، استرجاع، تحديث، وحذف الحملات البريدية الكاملة، والخطوات الفردية داخل الحملة.
إحصاءات البريد الإلكتروني: اسحب إحصاءات الأداء للرسائل الإخبارية، رسائل الحملات، ورسائل الأتمتة. يمكنك جلب النتائج لفترة معينة (حتى 31 يومًا) بتفصيل يومي، نتائج لكل بريد أرسل خلال تلك الفترة، أو جميع النتائج لفترة زمنية محددة لبريد معين. تشمل الإحصاءات الإرسال، الفتحات، النقرات، الارتدادات، والتقارير البريدية غير المرغوب فيها.
ج. إدارة المسارات ومحرر الصفحات:
أنشئ المسارات، خطوات الاشتراك، ومسارات الندوات: بسهولة إنشاء مسارات جديدة، إضافة خطوات اشتراك لمساراتك، وإنشاء مسارات ندوات مع جميع الخطوات اللازمة مثل صفحات التسجيل، الشكر، والبث.
عرض واسترجاع المسارات: تصفح المسارات الموجودة لديك، خطوات الاشتراك، وصفحات الندوة أو البحث عن معينة.
إعادة تكوين محتوى الصفحة (صفحات الندوة): إعادة تكوين المحتوى الكامل لصفحة الندوة.
محرر الصفحة: حفظ محتوى الصفحات المولدة مباشرة في خطوات المسار أو صفحات الموقع (استبدال كامل)، استرجاع مخططات JSON لأنواع معينة من الصفحات.
ملاحظات:
حاليًا، لا يتم دعم تحرير المسار وخطوات المسار عبر MCP.
لا يتم دعم حذف المسارات، خطوات المسارات، والصفحات الندوة حاليًا عبر MCP.
الذكاء الاصطناعي يستطيع إعادة تكوين محتوى صفحة الندوة عن طريق استبدال المحتوى الكامل، لكن التحريرات الصغيرة المستهدفة ليست مدعومة حاليًا.
د. إدارة خطط الأسعار والكوبونات:
إنشاء، تحرير، وحذف: إنشاء خطط أسعار جديدة وكوبونات، أو تحديثها جزئيًا وحذفها.
العرض والبحث: تصفح جميع خطط الأسعار والكوبونات الحالية لديك، أو الحصول على عناصر معينة بواسطة معرفها.
هـ. إدارة الدورات:
الدورات: إنشاء، تعديل الإعدادات، حذف، عرض، استرجاع، تفعيل، وتعطيل الدورات. عرض نماذج صفحات الدورة واختيار موضوع لدورتك.
الوحدات: إنشاء، تحرير، حذف، عرض، واسترجاع الوحدات لهيكلة دوراتك.
المحاضرات: إنشاء، تحرير، حذف، إضافة تأخير، تمكين التعليقات، عرض، استرجاع، تفعيل، وتعطيل المحاضرات.
ملاحظة عن الدورات: سيتم إضافة دعم لباقات الدورات في التحديثات المستقبلية.
و. إدارة المجتمع:
المجتمعات: استرجاع قائمة مجتمعاتك الحالية والوصول إلى قائمة الأعضاء الحاليين ضمن مجتمع محدد.
دعوة الأعضاء: دعوة أعضاء جدد برمجيًا للانضمام إلى مجتمعاتك عن طريق توفير معرف جهة اتصالهم.
ز. إدارة قواعد التشغيل الآلي:
إنشاء قواعد التشغيل الآلي: بسهولة ربط الأحداث والإجراءات الشائعة بدون إعدادها يدويًا في لوحة التحكم الخاصة بك. حاليًا، يمكنك إنشاء قواعد باستخدام المحفزات التالية: العلامات (إضافة علامة، إزالة علامة), الدورات (التسجيل في الدورة، إتمام الدورة، إتمام المحاضرة، إتمام الوحدة), المبيعات (فشل دفع الاشتراك، بيع جديد، إلغاء البيع), الاشتراك في نموذج المسار، إتمام الحملة، تم إنشاء الحجز، وتمت زيارة الصفحة. والإجراءات التالية: العلامات (إضافة علامة، إزالة علامة), الدورات (التسجيل في الدورة، إلغاء الوصول إلى الدورة), إلغاء الاشتراك من الحملة، إرسال نقاط التوزيع، وإرسال رسالة قصيرة (SMS).
عرض واسترجاع قواعد التشغيل الآلي: تصفح قواعد التشغيل الآلي الخاصة بك أو جلب قاعدة معينة بواسطة معرفها.
ح. إدارة الاشتراكات:
الاشتراكات: استرجاع قائمة جميع الموارد في اشتراك من منصات الطرف الثالث، وإلغاء الاشتراك إما فورًا أو في نهاية دورة الفواتير.
ط. إدارة نقاط التوزيع (Webhooks):
إنشاء نقاط توزيع جديدة برمجيًا لتلقي إشعارات في الوقت الفعلي، استرجاع قوائم نقاط التوزيع الحالية، وإزالة نقاط التوزيع غير المطلوبة.
ي. إدارة المنتجات الرقمية:
إنشاء، عرض، تحديث، وحذف: إدارة كاملة لمنتجاتك الرقمية.
العرض والبحث: تصفح منتجاتك الرقمية القائمة أو البحث عن المنتجات المحددة.
ربط خطط الأسعار: برمجيًا إنشاء أو ربط خطط الأسعار مباشرة بمنتجاتك الرقمية.
الاتصال بتدفقات البيع: برمجيًا وصل المنتجات الرقمية مع تدفقات البيع الخاصة بك (نماذج الطلب، الربح الإضافي، الخسارة الإضافية).
ك. إدارة المنتجات الفيزيائية:
إنشاء، عرض، تحديث، استرجاع، وحذف: إدارة كاملة لمنتجاتك الفيزيائية.
الاتصال بتدفقات البيع: برمجيًا وصل المنتجات الفيزيائية مع تدفقات البيع الخاصة بك (نماذج الطلب، الربح الإضافي، الخسارة الإضافية).
ل. إدارة إعدادات العروض والمبيعات:
إنشاء وتكوين العروض: إعداد عروض لتدفقات البيع الخاصة بك، كالنماذج، الربح، والخسارة الإضافية.
إدارة إعدادات المبيعات: تكوين الإعدادات التفصيلية لعروضك، بما في ذلك الكوبونات، ارتفاعات الطلب، العملات، طرق الدفع، إعدادات الضرائب، عمولات الشركاء، تأخيرات العوائد، وحدود المبيعات. يمكنك أيضًا بسهولة إرفاق المنتجات الرقمية والمادية بهذه العروض.
م. إدارة حجوزات الرزنامة:
إنشاء، تحديث، وحذف الأحداث: إنشاء فعاليات رزنامة حجز جديدة، أو بسهولة تعديل وحذف الفعاليات الموجودة.
قائمة والبحث عن الأحداث: استرجاع قائمة الأحداث في رزنامة حجزك أو البحث عن أحداث محددة بواسطة الاسم.
استرجاع تفاصيل الحدث: جلب تفاصيل كاملة لحدث معين، بما في ذلك المواقع، التوافر، نطاق التاريخ، والتذكيرات.
عرض وتصفية الحجوزات: استرجاع قائمة حجوزات رزنامتك وتصفية الحجوزات حسب الحدث، الحالة، ونطاق التاريخ.
ملاحظة عن أحداث الرزنامة: تحديث نوع حدث رزنامة موجود غير مدعوم حاليًا من خلال MCP.
ن. إدارة نماذج الرسائل القصيرة (SMS):
إنشاء، تحرير، وحذف: إنشاء نماذج رسائل قصيرة جديدة، أو تعديل أو إزالة الموجود منها.
العرض والبحث: استرجاع قائمة بنماذج الرسائل القصيرة الحالية أو البحث عن المححدة منها.
ملاحظات:
لتسهيل التعرف على وإدارة الرموز المميزة الخاصة بك، يجب على كل منها أن يكون لديه اسم فريد.
يمكن نسخ الرمز المميز فقط بعد إنشائه مباشراً. إذا نسيت نسخ الرمز المميز الخاص بك، فاحذفه وأنشئ واحدًا جديدًا.
وكتدبير أمني، سنرسل لك إشعارًا عبر البريد الإلكتروني في كل مرة يتم فيها إنشاء مفتاح واجهة برمجة التطبيقات العامة جديد في حسابك على systeme.io.
يمكنك إنشاء ما يصل إلى 3 مفاتيح API لكل حساب.
تعرف على المزيد: الوثائق الخاصة بـ API.