زيتون للمطورين

كيف أتصل بواجهة زيتون البرمجية

سنشرح في هذا المقال طريقة الاتصال بالواجهة البرمجية، والخطوات اللازمة للحصول على مفتاح API الخاص بك ومتطلبات استخدام الواجهة، وأهم الطلبات والروابط التي توفرها لك للحصول على المعلومات المطلوبة. متطلبات الاتصال يتطلب الاتصال ما يلي: مستخدم فعال أي مستخدم مسجل في مركز المساعدة الذي ترغب بإدراته عبر الواجهة البرمجية، ويتمتع بصلاحيات الوصول إلى البيانات التي تود إتاحتها له مثل الوصول إلى الإعدادات، و...

الاستيثاق Authentication

تتوفر نقطتا اتصال لتسجيل الدخول والخروج لمستخدمي تطبيقك. تسجيل الدخول تستخدم نقطة اتصال تسجيل الدخول login/ للاستيثاق والتحقق من هوية المستخدم، ومعرفة صلاحياته على مركز المساعدة ومنحه التصريح للوصول إلى البيانات والوظائف المناسبة. عند إرسال بريد المستخدم وكلمة المرور الخاصة به إلى نقطة الاتصال login/ ستعيد لك الواجهة معلومات عامة عن المستخدم مثل اسمه، ورقمه التعريفي id، وصورته الشخصية، وحالته فعّ...

رموز الاستجابات والأخطاء

ستحصل على رموز استجابة HTTP القياسية التالية رموز النجاح 2xx تشير الرموز 2xx إلى قبول الطلب ونجاح العملية، يشير الرمز 200 لنجاح عمليات GET، والرمز 201 لنجاح عمليات POST. رموز أخطاء جانب العميل 4xx تدل الرموز 4xx على وجود خطأ من جانب العميل، يتعلق ببنية الطلب نفسه أو بمفتاح API: 400 Bad Request خلل في الطلب، فالخادم لا يستطيع فهمه، قد تكون مشكلة في الترويسة مثلًا أو نقصًا بأحد المعاملات parameters...

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

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

طلب GET

نستعرض في هذا المقال إجراء طلبات GET مختلفة والمتطلبات الأساسية لذلك. طلب GET لعرض صناديق البريد بفرض لدينا مركز مساعدة على النطاق الفرعي support.example.com سنرسل طلب GET إلى نقطة الاتصال inboxes/ كما يلي: عنوان URL https://support.example.com/api/agent/v1/inboxes معاملات الاستعلام after نوعه مصفوفة array، يحدد صناديق البريد المدرجة بعد رقم تعريفي معين أو بعد تاريخ إنشاء معين أو بعد كليهما. befo...

طلب POST

نستعرض في هذا المقال تجربة إجراء طلبات POST مختلفة، والمتطلبات الأساسية لكل طلب من خلال أمثلة عملية بمختلف لغات البرمجة. طلب POST لإنشاء فريق جديد بفرض لدينا مركز مساعدة له النطاق الفرعي support.example.com ونريد إنشاء فريق جديد، سنرسل طلب POST لنقطة الاتصال teams/ عنوان الطلب support.example.com/api/agent/v1/teams جسم الطلب Body يكتب بصيغة JSON ويتضمن المعاملات التالية name معامل إجباري، نوعه سل...