NewAge Ai واجهة برمجة التطبيقات الرسمية
يتيح NewAge Ai الآن لمستخدميه الوصول إلى ميزاته وأدواتها المختلفة باستخدام مجموعة واسعة من نقاط نهاية واجهات برمجة التطبيقات المتاحة والتي يمكن الوصول إليها باستخدام بروتوكولات REST API.
تستخدم نقاط النهاية رمز حامل للتفويض وتعمل على بروتوكول https.
إنشاء رمز API الخاص بك
من لوحة التحكم في مساحة عملك، انقر على المنسدلة العليا اليمنى المجاورة لملف المستخدم الخاص بك ثم انقر على تبويب مفاتيح API.
من هنا، يمكنك ملء اسم الرمز، واختيار مساحة العمل والبوت الذي تريد إنشاء الرمز له، وإدارة الأصوات. بعد ذلك، انسخ رمزك.
رابط URL & المصادقة
الرابط الأساسي لجميع نقاط نهاية API سيكون
بالنسبة للشركاء، سيكون رابط القاعدة
https://[النطاق المخصص للشريك]/API
على سبيل المثال، إذا كان النطاق المخصص "app.testagency.ai" فسيكون عنوان الرابط الأساسي "app.testagency.ai"
وبالمثل، يمكن الوصول إلى جميع نقاط النهاية هنا
بالنسبة للشركاء، سيكون عنوان URL الأبيض الموسوم به:
https://[النطاق المخصص للشريك]/API
يستخدم NewAge Ai رمز الحامل كبروتوكول تفويض، وبالتالي يجب تمرير الرأس التالي لجميع استدعاءات API للمصادقة
التفويض: حامل {رمز وصول}
نقاط نهاية واجهات برمجة التطبيقات
التدفق
/التدفق/التدفقات الفرعية | يستخدم لجلب جميع التدفقات الفرعية الموجودة في البوت
/flow/bot-users-number | يوفر عددا لجميع مستخدمي البوتات الموجودين في البوت
/flow/agents | يجلب قائمة بجميع الوكلاء المتاحين في مساحة العمل
علامة التدفق
/flow/tags | يجلب ملف ليس لجميع العلامات المتاحة في البوت
/flow/create-tag | إنشاء وسم جديد
/flow/delete-tag | يحذف وسم موجود باستخدام الوسم NS
/flow/delete-tag-by-name | يحذف وسم موجود باستخدام اسم الوسم
حقل مستخدم التدفق
/flow/user-fields | يجلب جميع حقول المستخدم المتاحة في البوت
/flow/إنشاء حقل المستخدم | ينشئ حقل مستخدم جديد
/flow/delete-user-field | يحذف حقل المستخدم باستخدام varNS
/flow/delete-user-field-by-name | حذف حقل مستخدم باستخدام اسم حقل المستخدم
حقل الروبوتات المتدفق
/flow/bot-fields | يجلب جميع حقول البوت المتاحة في البوت
/flow/create-bot-field | ينشئ حقل بوت جديد
/تدفق/حقل-روبوت | تحديث قيمة حقل البوت باستخدام varNS
/flow/set-bot-field-by-name | تحديث قيمة حقل البوت باستخدام اسم الحقل الروبوتي
/flow/set-bot-fields | يقوم بتحديث عدة حقول بوت باستخدام varNS
/flow/set-bot-fields-by-name | تحديث عدة حقول بوت باستخدام أسماء حقول البوت
/flow/delete-bot-field | حذف حقل بوت موجود
/flow/delete-bot-field-by-name | يحذف حقل بوت موجود باستخدام اسم حقل البوت فيلد
مقاطع التدفق
/التدفق/المقاطع | يجلب قائمة بجميع المقاطع المتاحة في تدفق في البوت
حدث مخصص تدفق
/flow/أحداث مخصصة | يجلب قائمة بجميع الأحداث المخصصة في البوت
/flow/custom-events/summary | يوفر ملخصا لجميع الأحداث المخصصة
محادثة تدفق
/flow/conversations/data | يجلب بيانات المحادثة لتدفق معين (الوكيل يعين، لا يوجد فتح، إغلاق وما إلى ذلك
قالب واتساب
/whatstub-template/list | يجلب قائمة بجميع قوالب واتساب المتاحة
/whatsapp-template/create | إنشاء قالب واتساب جديد
/whatsapp-template/delete | حذف قالب موجود
/whatsapp-template/sync | مزامنة جميع القوالب من Business Manager مع NewAge Ai
المشترك
/المشتركون | يجلب قائمة بجميع مستخدمي البوتات المشتركين
/مشترك/get-info | يجلب مستخدم بوت مشترك معين باستخدام UserNS
/subscriber/get-info-by-user-id | يجلب مستخدم بوت مشترك باستخدام معرف المستخدم
/مشترك/إنشاء | إنشاء مستخدم بوت
/مشترك/تحديث | تحديث مستخدم بوت
/مشترك/حذف | يحذف مستخدم بوت
/مشترك/أضافة-وسم | يضيف وسم لمستخدم البوت
/subscriber/add-tags | إضافة عدة وسوم لمستخدم البوت
/مشترك/أضف-وسم-بالاسم | إضافة وسم بالاسم إلى مستخدم بوت
/مشترك/add-tags-by-name | أضف عدة علامات بالأسماء إلى مستخدم بوت
/subscriber/remove-tag | إزالة وسم من مستخدم بوت
/subscriber/remove-tags | إزالة عدة وسوم من مستخدم البوت
/مشترك/إزالة العلامة بالاسم | إزالة وسم بالاسم من مستخدم بوت
/مشترك/إزالة الوسوم بالاسم | إزالة وسوم متعددة بالأسماء من مستخدم بوت
/مشترك/إضافة تسميات بالاسم | أضف عدة تسميات بالأسماء إلى مستخدم البوت
/مشترك/إزالة التسميات بالاسم | إزالة عدة تسميات بالأسماء لمستخدم بوت
/subscriber/set-user-field | تحديث حقل المستخدم لمستخدم بوت
/subscriber/set-user-fields | تحديث حقول مستخدم متعددة لمستخدم بوت
/subscriber/set-user-field-by-name | تحديث حقل المستخدم بالاسم المستخدم المستخدم
/subscriber/set-user-fields-by-name | تحديث عدة حقول مستخدم حسب اسم المستخدم الروبوت
/subscriber/clear-user-field | امسح حقل المستخدم لمستخدم بوت
/subscriber/clear-user-fields | امسح عدة حقول مستخدم لمستخدم بوت
/مشترك/مسح حقل المستخدم بالاسم | تنظيف حقل المستخدم بالاسم لمستخدم البوت
/مشترك/مسح حقول المستخدم بالاسم | مسح عدة حقول مستخدم بالاسم لمستخدم بوت
/subscriber/pause-bot | إيقاف الأتمتة مؤقتا لمستخدم البوت
/subscriber/resume-bot | استئناف الأتمتة لمستخدم البوت
/مشترك/move-chat-to | يغير حالة محادثة مستخدم البوت (تم ذلك، معلق، إلخ)
/مشترك/وكيل التعيين | تعيين وكيل لمستخدم البوت
/subscriber/unassign-agent | إزالة وكيل من مستخدم روبوت
/subscriber/log-custom-event | يسجل حدثا مخصصا لمستخدم البوت
/مشترك/رسائل الدردشة | يجلب جميع رسائل الدردشة لمستخدم روبوت
/مشترك/chat-messages-by-mids | يجلب جميع رسائل الدردشة عبر الترددات المتوسطة لمستخدم البوت
الإرسال
/subscriber/send-main-flow | يرسل التدفق الرئيسي إلى مستخدم البوت
/subscriber/send-sub-flow | يرسل تدفقا فرعيا إلى مستخدم بوت
/subscriber/send-sub-flow-by-flow-name | يرسل تدفقا فرعيا بالاسم إلى مستخدم بوت
/subscriber/send-sub-flow-by-user-id | يرسل تدفقا فرعيا إلى مستخدم بوت باستخدام معرف المستخدم الخاص به
/مشترك/بث | يرسل بثا لمستخدمي البوتات
/subscriber/broadcast-by-user-id | يرسل بثا عبر معرفات المستخدم لمستخدم البوت
/مشترك/بث عبر الوسم | يرسل بثا لجميع المستخدمين بعلامة محددة
/مشترك/بث حسب فقرة | يرسل بثا لجميع المستخدمين مع مقطع محدد
/مشترك/أرسل-محتوى | يرسل محتوى إلى مستخدم بوت
/مشترك/أرسل-نص | إرسال رسالة نصية إلى مستخدم روبوت
/subscriber/send-sms | إرسال رسالة نصية إلى مستخدم روبوت
/subscriber/send-node | يرسل عقدة إلى مستخدم بوت
/subscriber/send-whatsapp-template | يرسل قالب واتساب إلى مستخدم بوت
/subscriber/send-whatsapp-template-by-user-id | يرسل قالب واتساب إلى مستخدم روبوت باستخدام معرف المستخدم (رقم واتساب)
تطبيقات صغيرة
/subscriber/app-trigger | يفعل فعل التفعيل في تطبيق صغير مثبت
التجارة الإلكترونية
/مشترك/cart | يجلب عربة مستخدم البوت
/مشترك/عربة فارغة | يتخلص من كارت مستخدم البوت
/مشترك/إضافة إلى سلة | يضيف منتجا إلى سلة مستخدم البوت
/مشترك/إزالة من السلة | إزالة منتج من سلة مستخدم البوت
/مشترك/مدفوع عبر العربة | علامة على عربة مستخدم روبوت مدفوعة
/subscriber/update-order-status | تحديث حالة الطلب لمستخدم البوت
/shop/discount-codes | يجلب جميع الخصومات
/shop/discount-codes/{codeId}/get-info | يجلب خصما محددا
/shop/discount-codes/get-info-by-code | يجلب خصما محددا حسب الكود
/تسوق/رموز خصم/إنشاء | أنشئ رمز خصم جديد
/shop/discount-codes/{codeId}/update | تحديث رمز الخصم
/shop/discount-codes/{codeId}/delete | حذف رمز الخصم
/shop/discount-codes/delete-by-code | يحذف رمز الخصم حسب الرمز
/shop/orders | يجلب جميع الطلبات
/shop/orders/{orderId}/get-info | جلب طلبا محددا
/المتجر/المنتجات | يجلب جميع المنتجات
/shop/products/{productId}/get-info | يجلب منتجا محددا
/تسوق/منتجات/إنشاء | ينشئ منتجا
/shop/products/{productId}/update | تحديث منتج معين
/shop/products/{productId}/delete | يحذف منتجا محددا
/shop/product-tags | يجلب جميع علامات المنتجات
/shop/product-tags/{tagId}/get-info | يجلب علامة منتج محددة
/shop/product-tags/create | ينشئ علامة منتج محددة
/shop/products-types/{typeId}/update | تحديث نوع المنتج
/shop/products-types/{typeId}/delete | حذف نوع المنتج
/المتجر/بائعو المنتجات | يجلب جميع بائعي المنتجات
/shop/product-vendors/{vendorId}/get-info | جلب مورد معين
/تسوق/بائعو المنتجات/إنشاء | ينشئ بائعا
/shop/product-vendors/{vendorId}/update | تحديث مورد معين
/shop/product-vendors/{vendorId}/delete | يحذف بائعا محددا
/المتجر/المواقع | يجلب جميع المواقع
/shop/locations/{locationId}/get-info | يجلب موقعا محددا
/تسوق/مواقع/إنشاء | إنشاء موقع
/shop/locations/{locationId}/update | تحديث الموقع
/shop/locations/{locationId}/delete | يحذف موقعا محددا
/shop/products/{productId}/variants | يجلب متغيرات منتج معين
/shop/products/{productId}/variants/{variantId}/get-info | يجلب نسخة محددة من منتج معين
/shop/products/{productId}/variants/{variantId}/update | تحديث نسخة محددة من منتج معين
/shop/products/{productId}/variants/{variantId}/delete | يحذف نسخة محددة من منتج معين
القوالب
/قوالب | يجلب جميع قوالب التدفق
/template/{templateNs}/generate-one-time-link | إنشاء رابط لمرة واحدة لقالب
علامة الفريق
/الفريق/العلامات | يجلب جميع التسميات
/flow/create-label | إنشاء علامة تجارية جديدة
/team/delete-label | حذف تسمية موجودة
/team/delete-label-by-name | حذف تسمية موجودة بالاسم
قوائم التذاكر
/team/ticket-lists | يجلب قائمة بجميع قوائم التذاكر المتاحة
/team/ticket-lists/{listId}/fields | يجلب قائمة بجميع الحقول المتاحة داخل قائمة محددة
/team/ticket-lists/{listId}/items | يجلب قائمة بجميع العناصر/التذاكر الموجودة حاليا في قائمة محددة
/team/ticket-lists/{listId}/log-data | يجلب بيانات جميع التغييرات التي مرت بها القائمة (العناصر الداخلة/الخارجة/إلخ)
/team/ticket-lists/{listId}/create | ينشئ تذكرة داخل قائمة
/team/ticket-lists/{listId}/update/{listItemId} | تحديث تذكرة داخل قائمة
/team/ticket-lists/{listId}/delete/{listItemId} | يحذف تذكرة داخل قائمة
التكامل
/التكامل/Shopify | إحضار، تعيين، أو حذف تكامل شوبيفاي
/التكامل/ووكومرس | جلب أو تعيين أو حذف تكامل ووكومرس
/integration/openai | جلب أو تعيين أو حذف تكامل OpenAI
/integration/s3storage | إحضار، تعيين أو حذف تكامل تخزين S3
الذكاء الاصطناعي المفتوح
/openai-embeddings | يجلب جميع التضمينات
/openai-embeddings/{id}/get-info | جلب تضمين معين
/openai-embeddings/create | ينشئ تضمين جديد
/openai-embeddings/{id}/update | تحديث تضمين جديد
/openai-embeddings/{id}/delete | حذف تضمين موجود
/openai-embeddings/import | التضمينات المستوردة
/openai-embeddings/generate | توليد التضمينات
مساحة العمل
/ملخص التدفق | يجلب ملخص التدفقات (المستخدمين، التحليلات)
/الملخص من وكيل التدفق. | ملخص وكلاء Fetches (تحليلات)
/team-bot-users | يجلب مستخدمي البوتات بغض النظر عن الروبوت في مساحة العمل
/تدفقات الفرق | احصل على قائمة بالروبوتات في مساحة العمل
/أعضاء الفريق | احصل على قائمة بالأعضاء في مساحة العمل
المستخدم
/أنا | احصل على المستخدم الحالي الذي أنشأ الرمز
الحدود
لدى واجهة برمجة التطبيقات حدود 1000 استدعاء API في الساعة