مقدمة

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

ما هي الواجهة البرمجية لزيتون

يوفر برنامج خدمة عملاء زيتون واجهة برمجية مرنة وشاملة من نوع RESTful API توفر لك كمطور كل التخصيص والتحكم الذي تحتاجه في إدارة خدمات مركز المساعدة. تتضمن هذه الواجهة عدة نقاط وصول منظمة بناء على الوظائف التي تقدمها، مثل المحادثات conversation، والدردشات المباشرة chats، والنماذج forms، وصناديق البريد inboxes ...إلخ.

ستجد في قاعدة معرفة زيتون للمطورين كل ما تحتاجه من معلومات حول كيفية إجراء الطلبات لكل نقطة وصول، ووصفًا تفصيليًا لكل طلب، وأمثلة عملية توضيحية، والكثير من المعلومات الضرورية للاستفادة من إمكانيات الواجهة البرمجية لزيتون بأفضل صورة ممكنة.

ترقيم الصفحات

تدعم واجهة زيتون البرمجية ميزة ترقيم الصفحات المُستند إلى المؤشرات Cursor Pagination، وتوفر معاملات يمكن استخدامها مع جميع نقاط الاتصال التي تتعامل مع قائمة من العناصر لتساعد في تصفح البيانات.

limit

نوعه عدد صحيح integer، يُحَدِّد عدد العناصر التي سيُرجعها لك الطلب في الاستجابة، قيمته الافتراضية هي 6 ويمكنك إعطاؤه قيمة أخرى حسب الحاجة، علمًا أن أكبر قيمة يمكن أن يأخذها هي 100.

after

نوعه مصفوفة array، يُحَدِّد الكائنات المدرجة بعد رقم تعريفي معين، أو بعد تاريخ إنشاء معين كما في المثال التالي:

after[id] = 10
after[created_at] = datetimezone

before

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

before[id] = 10
before[created_at] = datetimezone

مقالات قاعدة معرفة زيتون للمطورين

نظمنا مقالات قاعدة زيتون للمطورين على النحو التالي:

عام

يتضمن التصنيف عام مقالات حول أساسيات الواجهة البرمجية لزيتون، ويوضح طرق الاتصال بها بمختلف لغات البرمجة.

المحادثات

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

الدردشات المباشرة

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

الوكلاء

توضح المقالات تحت تصنيف الوكلاء كيفية إدارة الوكلاء أو موظفي الدعم الفني من إنشاء وتعديل وحذف والتحكم بالصلاحيات المختلفة.

صناديق البريد

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

النماذج

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

الشركات

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

الأشخاص

تشرح مقالات تصنيف الأشخاص خطوات إدارة الأشخاص المسجلين في مركز المساعدة من استعلام وإضافة وتعديل ودمج وحذف.

فئات جهات الاتصال

تتضمن المقالات تحت تصنيف فئات جهات الاتصال كيفية إدارة الفئات التي تساعد على تصنيف جهات الاتصال كالأشخاص والشركات ضمن مركز المساعدة.

الحقول المخصصة

تشرح مقالات الحقول المخصصة خطوات إدارة الحقول المخصصة لنماذج تعريف الوكلاء والأشخاص والشركات ضمن مركز المساعدة.

الوسوم

تعرض المقالات المنشورة ضمن تصنيف الوسوم كل ما تحتاجه لعرض الوسوم التابعة لكافة أنواع البيانات الموجودة ضمن مركز المساعدة كالمحادثات والمقالات والنماذج.

المقالات

تتضمن مقالات قاعدة المعرفة المنشورة في تصنيف المقالات كل ما يتعلق بإدارة المقالات ضمن قاعدة المعرفة التابعة لمركز المساعدة.

البحث

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

قاعدة المعرفة

تتضمن المقالات المنشورة تحت التعامل مع قاعدة المعرفة كيفية التعامل مع كافة عناصر قاعدة المعرفة ضمن مركز المساعدة والتحكم في الكتل والقوائم ضمنها.

ابدأ باستكشاف مقالات قاعدة معرفة زيتون للمطورين وتعرف على طريقة دمجها مع تطبيقاتك البرمجية المخلتفة.