ستجد هنا مقدمة بسيطة عن الJSON API. للتفاصيل التقنية، تفقد هذا المقال.
ما هو JSON API؟
يتيح لك الJSON API أن ترسل بيانات من البوت عن طريق طلب http فيمكنك استخدامه لتتمكن من:
-
حفظ متغيرات المستخدمين لقاعدة البيانات أو نظام أدارة العملاء الخاص بك.
-
إرسال الإشعارات للنظام الخاص بك
-
القيام بمهامِ ما للعميل كعمل طلب لهم.
-
تمكين المهام بنظامك حسب المستخدم.
يمكنك إعداد طلب JSON API عن طريق الزر المخصص له في منشئ البوت.
بالأسفل يوجد بعض التعريفات التي يجب عليك فهمها لتتمكن من فهم الـJSON API بشكل أفضل. إذا كنت مبرمج يمكنك تخطي التعريفات:
API: هو الطريقة التي يتواصل بها تطبيقين مع بعضها البعض
متغيرات: هي معلومة يمكنك حفظها عن المستخدم كالاسم.
نقطة نهاية: الرابط الذي يستخدمه الـAPI الخاص بك ليوصل الطلب الخاص بك.
عنوان الطلب: معلومات إضافية عن الطلب ويتكون من تصنيف وقيمة حيث تكون القيمة هي محتوى الطلب والتصنيف هو اسمه.
محتوى الطلب: محتوى الطلب من نوع نشر/وضع ويكون في صيغة JSON
رد طلب الـAPI: رد الـAPI على الطلب والذي من الممكن أن يكون بيانات أو مجرد تأكيد أن الـ API قد استلم الطلب.
طلب استدعاء: يستخدم عندما لا يوجد رد أو في حالة إتخاذ الطلب وقت أطول من الوقت الممكن. يمكن أن يكون طلب الاستدعاء رابط وتوكن كطلب جديد.
طلب أحتياطي: طلب تعده عندما يفشل طلب الـAPI
كيف تستخدم JSON API؟
يمكنك استخدام JSON API بأحد الطرق الموجودة بالجدول حيث سيوضح لك الجدول كذلك كيف يمكنك أن تخصص الطلب في كل طريقة.
استخدام أي من هذه الطرق سيرسل طلب للـAPI الخاص بك بالقيم التي ستحددها أنت وسيتولى الـAPI باقي العملية تلقائيًا، ولكن يرجى العلم أن:
-
اقصى عدد حروف مسموح به لطلب API هو 500 حرف
-
اكبر حجم لرد الـJSON API هو 4 MB
-
ينتهي الطلب مالم يتم الرد عليه خلال 10 ثواني
بعد إنتهاء الـAPI من طلبك يمكن للبوت أن يقوم بأي من المهام التالية:
-
تحديد قيمة لمتغير
-
إرسال رسالة عن طريق فيسبوك
-
توجيه المستخدم لمجموعة رسائل معينة
ويمكن ألا يفعل أي شئ بعد ذلك.
يمكنك تخصيص هذا بتحديد محتوى رد الـAPI أو إنشاء طلب استدعاء.