API Mewayz الوظيفة الإضافية
اكتشف قوة تكامل واجهة برمجة التطبيقات الخاصة بـ Mewayz لإدارة المشاريع والمهام بشكل سلس. قم بالتوسيع والتخصيص بسهولة. حاول الآن!
مقدمة
يعد API Docs Generator وظيفة إضافية قوية توفر وثائق API كاملة لمنصة Mewayz. تساعد هذه الوظيفة الإضافية المطورين والفرق الفنية على الوصول إلى معلومات API التفصيلية، بما في ذلك نقاط النهاية والرؤوس والمعلمات وأمثلة الاستجابة. تغطي الوثائق 14 وحدة رئيسية للنظام الأساسي وتمكن المستخدمين من إنشاء تطبيقات مخصصة أو دمج الأنظمة الخارجية أو اختبار واجهات برمجة التطبيقات يدويًا باستخدام أدوات مثل Postman.
كيفية تمكين هذه الوحدة
لإعداد إضافة API، يمكنك اتباع هذا الرابط: إضافة الإعداد.
كيفية استخدام إضافة API؟
إنشاء مستندات API
بعد شراء هذه الإضافة وتثبيتها، انتقل إلى الشريط الجانبي للوحة المعلومات وابحث عن إضافة وثائق API.
للوصول إلى وثائق API، انتقل إلى قسم Api Docs من لوحة معلوماتك الرئيسية. الوثائق منظّمة حسب 14 وحدة، مما يسهّل العثور على واجهات برمجة التطبيقات المحددة التي تحتاجها لمشروع التكامل الخاص بك.
يتضمّن القسم مقدمة عامة تشرح كيفية استخدام واجهات برمجة التطبيقات بفعالية. تغطي هذه النظرة العامة متطلبات المصادقة والترويسات الشائعة وإرشادات الاستخدام الأساسية التي تنطبق على جميع نقاط نهاية واجهة برمجة التطبيقات.
تحتوي كل وحدة على قوائم قوية لواجهة برمجة التطبيقات مع تفاصيل تقنية كاملة. لكل نقطة نهاية لواجهة برمجة التطبيقات، ستجد اسم الواجهة، وعنوان URL الدقيق لنقطة النهاية، والترويسات المطلوبة للمصادقة وتنسيق البيانات، ومعلمات الإدخال مع أنواع بياناتها وقواعد التحقق منها، وأمثلة على استجابات النجاح التي تُظهر بنية البيانات المتوقعة، وأمثلة على استجابات الخطأ مع رموز الأخطاء الشائعة ورسائلها.
إدارة المقدمة
تعد وثائق واجهة برمجة التطبيقات الشاملة هذه بوابتك لتسخير قوة ميزات Mewayz، مما يسمح لك بتبسيط عملك وتعزيز الإنتاجية والارتقاء بمشروعاتك إلى المستوى التالي.
تعد وثائق واجهة برمجة التطبيقات (API) هذه مصدرًا للمطورين، سواء المتمرسين أو الجدد، الذين يرغبون في الاستفادة من إمكانات Mewayz داخل تطبيقاتهم. إليك ما يمكنك توقع العثور عليه.
يمكنك تصفح المرجع الكامل التفاعلي داخل المنتج ضمن الإعدادات → مستندات API.
يغطي قسم نقاط النهاية أمر GET لاسترداد البيانات، وPOST لإنشاء بيانات جديدة، وPOST لتحديث البيانات الموجودة، وDELETE لإزالة البيانات. يمكنك استخدام طرق HTTP مثل GET لاسترداد البيانات، وPOST لإنشاء بيانات جديدة، وPOST لتحديث البيانات الموجودة، وDELETE لإزالة البيانات.
تُستخدم معلمات الطلب لتخصيص سلوك طلبات واجهة برمجة التطبيقات (API) الخاصة بك وتوفير تفاصيل أكثر تحديدًا عند التفاعل مع واجهة برمجة التطبيقات (API). بالنسبة إلى Mewayz، قد يكون لديك الأنواع التالية من معلمات الطلب: معلمات الاستعلام لتصفية البيانات أو فرزها عند استرداد المعلومات، ورؤوس الطلب للمصادقة وبيانات التعريف الإضافية حول الطلب، ونص الطلب الذي يحتوي على بيانات JSON المراد إنشاؤها أو تحديثها.
تستجيب واجهة برمجة التطبيقات الخاصة بـ Mewayz عادةً بالبيانات بتنسيق JSON. تتضمن الاستجابة عادةً رمز حالة HTTP يشير إلى نتيجة الطلب، ويتم تضمين البيانات الفعلية داخل الملف "البيانات" حقل.
إدارة المصادقة
توفّر واجهات برمجة تطبيقات المصادقة وظيفة تسجيل الدخول الأساسية، وقدرات تحديث الرموز للحفاظ على الجلسات، وإجراءات تسجيل الخروج لإنهاء جلسات المستخدم بأمان.
تتطلّب نقطة نهاية تسجيل الدخول POST /api/login رؤوسًا مع «قبول»: “application/json” والمعاملات بما في ذلك البريد الإلكتروني مثل “[email protected]” وكلمة المرور مثل **"جون****"**.
ترجع ردود الأخطاء 422 Unprocessable Content مع "نجاح": false, "رسالة": «التحقق عندما يكون التحقق خطأ.
تُرجع استجابات الخطأ 400 Unauthorized مع "نجاح": false, "رسالة": «المقدَّم» عندما تكون بيانات الاعتماد غير صالحة.
تُرجِع استجابات تسجيل الدخول الناجحة 200 OK مع "نجاح": صحيح، والتفويض يحتوي على رمز ونوع “bearer” لاستدعاءات API اللاحقة.
تستخدم نقطة نهاية تحديث المصادقة POST /api/refresh رؤوس التفويض مع رمز Bearer لإدارة الجلسات.
تُرجِع استجابات التحديث الناجحة معلومات مستخدم مفصّلة، بما فيها 200 OK مع "نجاح": true، وتفاصيل المستخدم، id، name، email، mobile_no، type : «الشركة»، الصورة الرمزية: "الرابط"، اللغة: “en” ورمز.
إدارة المستخدمين
- واجهات برمجة تطبيقات المستخدم لإدارة المستخدم وإدارة الأدوار والملف الشخصي
العمليات.
إدارة المستودعات
- واجهات برمجة تطبيقات المستودعات لتهيئة المستودعات وعمليات النقل بينها
الإدارة.
إدارة المنتجات والخدمات
- تدير واجهات برمجة قسم المنتجات والخدمات فئات المنتجات والضرائب،
وحدات القياس، والمنتجات، وإدارة المخزون مع تكامل المستودعات.
إدارة فواتير الشراء
- واجهات برمجة تطبيقات فاتورة الشراء لقائمة فاتورة الشراء، والإنشاء، والتفاصيل،
تحديث، حذف، إدارة قيد الفواتير.
إدارة مرتجعات المشتريات
- واجهات برمجة تطبيقات للتعامل مع قائمة مرتجعات الشراء والإنشاء وتفاصيل المرتجع،
حذف، اعتماد، إكمال المعالجة.
إدارة عروض المبيعات
- واجهات برمجة تطبيقات عرض المبيعات لإدارة العروض وتحويلها
العمليات.
إدارة فواتير المبيعات
- تتعامل واجهات برمجة تطبيقات فواتير المبيعات مع قائمة الفواتير وإنشائها وتحديثها وحذفها،
إدارة ترحيل الفواتير.
إدارة مرتجعات فواتير المبيعات
- واجهات برمجة لإدارة قائمة مرتجعات فواتير المبيعات والإنشاء والتفاصيل والحذف،
اعتمد وأكمِل.
إدارة الحسابات
- تتيح لك واجهات برمجة تطبيقات قسم الحساب إدارة العملاء والموردين،
- تتضمن وحدة الحساب واجهات برمجة تطبيقات قوائم سريعة لاسترجاع البيانات البسيطة
سجلات الحسابات البنكية، دليل الحسابات، الإيرادات، المصروفات، إشعارات الدائن، إشعارات المدين، مدفوعات البائعين، مدفوعات العملاء، المعاملات البنكية، التحويلات البنكية. يمكنك إجراء عمليات مثل سرد السجلات، وإنشاء إدخالات جديدة، وعرض التفاصيل، وتحديث المعلومات، وحذف السجلات حسب الحاجة.
قوائم العملاء والمورّدين، وقائمة حسابات دفتر الأستاذ العام، إلى جانب فئات الإيرادات والمصروفات للاختيارات المنسدلة والمراجع السريعة.
إدارة المشاريع
- تدير واجهات برمجة تطبيقات قسم المشاريع المشاريع والمهام والأخطاء والمعالم،
الملفات ومختلف التقارير مع مراحلها وسير العمل المرتبط بها.
إدارة نقاط البيع
- تتعامل واجهات برمجة تطبيقات نقطة البيع مع عمليات نقطة البيع، بما في ذلك إدارة الطلبات
وتفاصيل الطلب.
إدارة CRM
- تغطي واجهات برمجة تطبيقات قسم إدارة علاقات العملاء إدارة المسار، ومراحل العملاء المحتملين والصفقات،
التسميات والمصادر وإدارة العملاء المتوقعين الكاملة وإدارة الصفقات. يمكنك إدارة المهام والمستخدمين والمنتجات والمصادر ورسائل البريد الإلكتروني والمناقشات والملفات والمكالمات المرتبطة بكل من العملاء المتوقعين والصفقات.
إدارة الموارد البشرية
- تتولّى واجهات HRM البرمجية إدارة الموظفين والهيكل التنظيمي،
تتبع الحضور، وإدارة الإجازات، ومعالجة الرواتب، وسجلات الموارد البشرية المختلفة بما في ذلك الجوائز والترقيات والاستقالات وإنهاء الخدمة والإنذارات والشكاوى وتحويلات الموظفين والعطلات والفعاليات والمستندات والإعلانات والإقرارات.
يتضمن كل نقطة نهاية API في الوثائق أمثلة عملية يمكنك نسخها واستخدامها مباشرةً في بيئة التطوير أو أدوات الاختبار. تُظهر أمثلة الاستجابة كلاً من العمليات الناجحة وسيناريوهات الأخطاء الشائعة، ما يساعدك على تنفيذ معالجة أخطاء سليمة في تطبيقاتك.
قائمة واجهات برمجة التطبيقات حسب الوحدات:
- المصادقة :
- تسجيل الدخول
- تحديث الرمز المميز
- تسجيل الخروج
- المستخدم :
- المستخدم : القائمة، والإنشاء، والتحديث، والحذف،
- الدور: قائمة
- سجل المستخدم : قائمة
- مستخدمو الموظفين: قائمة
- مستخدمو العميل : قائمة
- مستخدمو المورّد : قائمة
- المستودع:
تحديث الملف الشخصي، تحديث كلمة المرور، إعادة تعيين كلمة المرور، التحقق
- المستودع: عرض القائمة، إنشاء، تفاصيل، تحديث،
- تحويل : قائمة، إنشاء بيانات الطلب،
- المنتج والخدمة :
حذف
إنشاء، حذف
- فئة المنتج: عرض، إنشاء، تحديث،
- الضريبة: قائمة، إنشاء، تحديث، حذف
- الوحدة: قائمة، إنشاء، تحديث، حذف
- المنتج : عرض القائمة، إنشاء، تفاصيل، تحديث،
- مخزون المنتج: قائمة، إضافة
- منتج المستودع: قائمة
- فاتورة الشراء:
حذف
حذف
- الفاتورة: عرض القائمة، إنشاء، تفاصيل، تحديث،
- مرتجع المشتريات :
حذف، نشر
- إرجاع: قائمة، إنشاء، تفاصيل، حذف،
- عرض المبيعات المقترح:
الموافقة، الإكمال
- العرض : عرض القائمة، إنشاء، تفاصيل، تحديث،
- فاتورة المبيعات:
حذف، إرسال، قبول، رفض، تحويل إلى فاتورة
- الفاتورة: عرض القائمة، إنشاء، تفاصيل، تحديث،
- إرجاع فاتورة المبيعات :
حذف، نشر
- إرجاع: قائمة، إنشاء، تفاصيل، حذف،
- الحساب :
الموافقة، الإكمال
- احصل على العملاء: قائمة عملاء بسيطة
- احصل على الموردين : قائمة موردين بسيطة
- العميل: قائمة، إنشاء، تحديث، حذف
- المورّد: قائمة، إنشاء، تحديث، حذف
- حساب دفتر الأستاذ العام : قائمة
- الحساب المصرفي : قائمة، إنشاء، تحديث، حذف
- فئات الإيرادات: قائمة
- الإيرادات : القائمة، والإنشاء، والتحديث، والحذف،
- فئات المصروفات : قائمة
- المصروف : القائمة، والإنشاء، والتحديث، والحذف،
- أنواع الحسابات : قائمة
- دليل الحسابات: قائمة
- معاملة بنكية : قائمة
- تحويل بنكي: قائمة
- مدفوعات الموردين : قائمة
- مدفوعات العملاء : قائمة
- إشعار دائن: قائمة
- إشعار مدين : قائمة
- المشروع:
الموافقة، الترحيل
الموافقة، الترحيل
- المشروع: عرض القائمة، إنشاء، تفاصيل، تحديث،
- عضو المشروع : حذف
- عميل المشروع: قائمة، دعوة، حذف
- مرحلة المشروع: عرض، إنشاء، تحديث،
- ملف المشروع: إنشاء، حذف
- المهمة: لوحة المهام، إنشاء، تفاصيل، تحديث،
- تعليق المهمة: إنشاء، حذف
- المهمة الفرعية للمهمة : إنشاء، تحديث
- حالة الخطأ: قائمة
- خطأ: قائمة، إنشاء، تفاصيل، تحديث، حذف
- تعليق الخطأ : إنشاء، حذف
- تقرير المشروع : قائمة، تفاصيل
- مرحلة المهمة: قائمة، طلب، إنشاء، تحديث،
- مرحلة الخلل: قائمة، طلب، إنشاء، تحديث،
- نقاط البيع:
حذف
حذف
حذف
حذف
حذف
- الطلب : قائمة، تفاصيل
- إدارة علاقات العملاء :
- مسار المبيعات : قائمة، إنشاء، تحديث، حذف
- مرحلة العميل المحتمل: قائمة، إنشاء، تحديث، حذف
- مرحلة الصفقة: قائمة، إنشاء، تحديث، حذف
- التسميات: قائمة، إنشاء، تحديث، حذف
- المصادر : قائمة، إنشاء، تحديث، حذف
- العميل المحتمل : عرض القائمة، إنشاء، تفاصيل، تحديث،
- مهمة العميل المحتمل: إنشاء، تحديث، حذف
- المستخدم العميل المحتمل: إنشاء، حذف
- المنتج الرئيسي: إنشاء، حذف
- مصدر العميل المحتمل : إنشاء، حذف
- البريد الإلكتروني للعميل المحتمل: إنشاء
- مناقشة العميل المحتمل : إنشاء
- ملف العميل المحتمل: إنشاء، حذف
- مكالمة عميل محتمل : إنشاء، تحديث، حذف
- الصفقة: عرض القائمة، إنشاء، تفاصيل، تحديث،
- مهمة الصفقة : إنشاء، تحديث، حذف
- مستخدم الصفقة : إنشاء، حذف
- منتج الصفقة: إنشاء، حذف
- مصدر الصفقة: إنشاء، حذف
- البريد الإلكتروني للصفقة : إنشاء
- مناقشة الصفقة: إنشاء
- ملف الصفقة: إنشاء، حذف
- عميل الصفقة: إنشاء، حذف
- مكالمة الصفقة: إنشاء، تحديث، حذف
- الموارد البشرية:
حذف، إضافة تسمية، تحويل إلى صفقة
حذف، إضافة تصنيف
- الموظف: عرض القائمة، إنشاء، تفاصيل، تحديث،
- الحضور: قائمة، إنشاء، تحديث، حذف
- أنواع الإجازات : قائمة
- طلبات الإجازة: عرض، إنشاء، تحديث،
- أرصدة الإجازات: تحقّق
- كشوف الرواتب: قائمة، تفاصيل
- قسيمة الراتب : توليد
- المناوبات: قائمة
- الفروع: قائمة
- الأقسام: قائمة
- المسميات الوظيفية : قائمة
- أنواع المستندات : قائمة
- العطلات: قائمة
- الجوائز: قائمة
- العروض الترويجية: قائمة
- الاستقالات: قائمة
- إنهاءات الخدمة : قائمة
- تحذيرات : قائمة
- الشكاوى : قائمة
- نقل الموظفين: قائمة
- المستندات : قائمة
- الشكر والتقدير: قائمة
- الإعلانات: قائمة
- الأحداث : قائمة
حذف
حذف، تحديث الحالة