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

عائلات API

يحتوي Plato على نمطين API يواجهان العملاء.

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

اختر مضيف API الصحيح للإنتاج وإعداد وحدة التحكم والبيئات الخاصة والتطوير المحلي.

المصادقة

أرسل مفاتيح Plato API بأمان باستخدام العناوين واحتفظ بالمفاتيح بعيدًا عن التعليمات البرمجية العامة.

الأذونات

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

الأخطاء والحدود

تعامل مع الأخطاء الشائعة وحدود ترقيم الصفحات وحدود المعدلات وعمليات إعادة المحاولة الآمنة.

واجهات برمجة التطبيقات للبيانات وسير العمل

CMS API

قراءة وكتابة إدخالات CMS المنظمة من مواقع الويب والتطبيقات والواجهات الخلفية الموثوقة.

Connect360 API

أنشئ دردشة على موقع الويب ومحادثة ومرفقات وتدفقات الرسائل بمساعدة AI.

واجهات برمجة تطبيقات المطاعم

اقرأ منتجات القائمة والفئات وبيانات موجز الطلبات الحديثة.

نماذج API

جلب مخططات النماذج العامة وإرسال استجابات النماذج الموثوقة.

الخلفية المكتوبة API

يتم استخدام مكالمات الواجهة الخلفية المكتوبة لعمليات التكامل المحددة من جانب الخادم. استخدامه ل:
  • محادثات ورسائل ومرفقات Connect360 وردود AI.
  • الوصول إلى تغذية طلب المطعم.
  • أشكال الطلب والاستجابة المكتوبة التي تم إنشاؤها من Plato.
تمر طلبات SDK عبر:
https://api.plato.ae/api/trpc
يركز الشريط الجانبي العام على عائلات API المستقرة أولاً. استخدم صفحة عائلة API ذات الصلة عند تحديد الطريق الذي تريد الاتصال به.

REST واجهات برمجة التطبيقات العامة

تكون واجهات برمجة تطبيقات REST العامة أفضل عندما يحتاج موقع ويب أو أداة بدون تعليمات برمجية أو واجهة خلفية غير TypeScript إلى نقاط نهاية HTTP عادية. استخدمها من أجل:
  • إدخالات CMS.
  • منتجات القائمة والفئات.
  • النماذج العامة.
  • النماذج الديناميكية القديمة.
تمر طلبات REST عبر:
https://api.plato.ae
ابدأ بـ المصادقة، ثم افتح عائلة API التي تحتاجها.

ما ليس API العام

توجد بعض المسارات حتى يتمكن Plato من تشغيل وحدة التحكم أو معالجة خطافات الويب أو عرض ملفات PDF أو مصادقة المستخدمين. هذه الطرق ليست عقود تكامل عامة مستقرة. لا تقم بإنشاء عمليات تكامل خارجية ضد مسارات مثل عمليات رد اتصال المصادقة أو خطافات الويب الخاصة بالموفر أو الشريط أو وظائف cron أو صور Open Graph أو طلبات متصفح وحدة التحكم الداخلية. راجع الطرق الداخلية للحصول على القائمة المختصرة للطرق التي يجب تجنبها.

قبل أن تبني

  1. إنشاء دور مخصص للتكامل.
  2. امنح هذا الدور الأذونات التي يحتاجها فقط.
  3. قم بإنشاء مفتاح API في وحدة التحكم.
  4. قم بتخزين المفتاح في مخزن سري من جانب الخادم.
  5. اختبر بطلب صغير قبل إرسال حركة الإنتاج.
إنشاء مفاتيح من مفاتيح وحدة التحكم API.