API لتقف على واجهة برمجة التطبيقات. يشار إلى أي برنامج بوظيفة معينة على أنه تطبيق عند مناقشة واجهات برمجة التطبيقات. يمكنك مقارنة واجهة API باتفاقية خدمة بين برنامجين يحددان الطلبات والاستجابات. إذا كنت مستخدمًا جديدًا لواجهات برمجة التطبيقات ، فننصحك بمراجعة دليل المبتدئين لواجهات برمجة التطبيقات و نظرة عامة على REST APIs بلوق قبل قراءة هذا واحد.
واجهات برمجة التطبيقات REST تسمح لك بالوصول إلى بيانات CRM من خلال بروتوكول HTTP / HTTPS. يمكنك تنفيذ إجراءات مثل إنشاء أو تحديث أو استرداد أو حذف عمليات على أي معلومات سجل CRM. سيسمح لك أيضًا بتخزين بيانات التكوين الخاصة بالامتدادات والخاصة بالمستخدم أو الاتصال بالتطبيقات الخارجية باستخدام البيانات المخزنة الخاصة بالملحق. يمكن الوصول إلى كل هذه البيانات باستخدام التفويض الأساسي ، أي عن طريق اسم المستخدم ومفتاح الوصول.
إنشاء واجهة برمجة تطبيقات REST
فيما يلي الخطوات الخمس العامة التي يمكنك استخدامها لبناء أي API:
- تخطيط API: يتم توفير إرشادات تصميم API الخاص بك من خلال مواصفات API مثل OpenAPI. يُفضل النظر في حالات الاستخدام المختلفة مسبقًا والتأكد من أن واجهة برمجة التطبيقات تتوافق مع معايير تطوير API الحالية.
- بناء API: ينشئ مصممو واجهة برمجة التطبيقات نماذج أولية من واجهات برمجة التطبيقات الجديدة مع القليل من التعديلات على واجهات برمجة التطبيقات الحالية. يمكن للمطورين تكييف النموذج الأولي مع المتطلبات الداخلية بعد خضوعه للاختبار.
- اختبار API: على غرار اختبار البرامج ، يعد اختبار API ضروريًا للحماية من الأخطاء والعيوب. اختبر واجهة برمجة التطبيقات للتحقق من قوتها ضد الهجمات عبر الإنترنت باستخدام أدوات لاختبار واجهة برمجة التطبيقات.
- توثيق API: على الرغم من أن واجهات برمجة التطبيقات تشرح نفسها بنفسها ، إلا أن التوثيق يمكن أن يساعد المستخدمين بسهولة أكبر. في البنية الموجهة نحو الخدمة ، يتم استخدام واجهات برمجة التطبيقات (API) الموثقة جيدًا مع وظائف وحالات استخدام متنوعة بشكل متكرر. اكتب مستند تعليمات لإعطاء التوجيهات ومساعدة الآخرين في بناء واجهات برمجة التطبيقات الخاصة بهم.
- تسويق API: هناك أسواق عبر الإنترنت حيث يمكن للمطورين شراء وبيع واجهات برمجة التطبيقات للآخرين ، تمامًا كما هو الحال بالنسبة لسلع التجزئة على eBay و Amazon و Flipkart. يمكنك كسب المال من API الخاص بك عن طريق إدراجها.
ستعلمك هذه المدونة كيفية إنشاء أمر REST API مخصص باستخدام Vtiger's API Designer. اذا هيا بنا نبدأ.
ما هو مصمم API؟
مصمم API هو أداة أو مطوري التطبيقات يمكنهم استخدامها لبناء واجهات برمجة تطبيقات مخصصة لخدمة الويب. يمكنك تحديد نقاط نهاية الخدمة المخصصة ومعلمات الاستعلام. يمكن استخدام واجهات برمجة التطبيقات هذه للتفاعل مع بيانات CRM ، والتكامل مع التطبيقات الخارجية وأيضًا تعريض هذه البيانات لواجهات برمجة تطبيقات VTAP Javascript لاستخدامها في الصفحات المخصصة أو عناصر واجهة المستخدم في Vtiger UI.
يمكنك إنشاء واجهات برمجة التطبيقات باستخدام لغة تصميم تطبيق Vtiger (فادل) ، والذي يعتمد بشكل فضفاض على بناء جملة XML. يمكّن VADL المسؤولين أو المطورين الذين ليس لديهم مهارات برمجة عالية المستوى من تحديد واجهات برمجة التطبيقات بسهولة ، ولكن مع الفهم الأساسي للبرمجة ، يمكنك إنشاء واجهات برمجة تطبيقات فعالة بسرعة.
تتبع واجهات برمجة تطبيقات REST بروتوكول REST API القياسي ، ويمكنك تحديد نقاط النهاية الخاصة بها على النحو التالي:
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
بالنسبة لـ REST API ، يتم دعم طرق طلب HTTP التالية:
- للحصول على
- سأعين
- ضع
- حذف
دعنا نرى كيف يمكنك استخدام VTAP لبناء واجهة برمجة تطبيقات REST المخصصة الخاصة بك.
يمكن لمستخدمي Vtiger CRM إنشاء واجهات برمجة تطبيقات REST التي من شأنها توصيل CRM بتطبيقات الطرف الثالث الأخرى أو إنشاء تطبيقات جديدة من شأنها توسيع وظائف CRM. هنا مثال:
دعونا ننشئ واجهة برمجة تطبيقات REST يمكنها ذلك الوصول إلى البيانات من محدد وحدة باستخدام VTAP.
فيما يلي مثال على API الذي يسترد البيانات من وحدة CRM تسمى المنظمات لعرض أفضل خمس مؤسسات ذات أعلى عائد سنوي مع اسم واجهة برمجة التطبيقات كـ أهم المنظمات. يمكنك استخدام اسم مختلف لإبقائه فريدًا.
قبل أن نبدأ ، دعونا نفهم مكونات XML و VDAL التي سيتم استخدامها لتحديد إجراءات مثال API أعلاه.
يصف الجدول التالي مكونات XML و VDAL التي سيتم استخدامها لتحديد واجهة برمجة تطبيقات REST المخصصة للوصول إلى بيانات CRM وعرضها:
| مكون XML و VDAL | اكشن |
|---|---|
| طريقة api = "get" | تحديد طريقة طلب HTTP |
| حدد الوحدة = "الحسابات" | حدد الوحدة لاسترداد البيانات من الاستخدام حدد |
| سجل اسم الحقل = ”اسم الحساب”> | حدد الحقول في السجل لاسترداد البيانات من استخدامها سجل |
| sort اسم الحقل = "year_revenue" الترتيب = "تنازلي" / الحقل /نوع |
حدد شروط نتيجة الجدول باستخدام sort |
| الحد الأقصى = ”5 ″ صفحة =” @ صفحة ”/ حد | حدد عدد تفاصيل السجل التي سيتم عرضها باستخدام قصر |
| /تحديد / api |
اختتم بإغلاق جميع العلامات المفتوحة |
ملاحظات أنه يجب إرفاق جميع مكونات XML و VDAL في الجدول أعلاه بعلامات (<>).
اتبع هذه الخطوات لإنشاء واجهة برمجة تطبيقات REST التي تمت مناقشتها أعلاه:
- قم بتسجيل الدخول إلى حساب Vtiger CRM الخاص بك.
- انقر على القائمة الرئيسية.
- انقر المنظومة.
- اختر مصمم API.
- انقر + إضافة API.
- انقر إنشاء بجانب REST API. تفتح نافذة إضافة REST API.
- أضف REST API: أدخل أو حدد المعلومات لما يلي:
- وحدة: حدد وحدة CRM التي يجب الوصول إلى البيانات من خلالها.
- الاسم: أدخل معرفًا فريدًا لواجهة برمجة التطبيقات.
- الحالة: انقر فوق مربع الاختيار لتنشيط API.
- انقر التوفير .
- بعد إضافة واجهة برمجة التطبيقات ، سترى IDE مدمجًا حيث ستستخدم VADL لتحديد واجهات برمجة التطبيقات وعقد XML لاسترداد بيانات CRM. راجع الجدول أعلاه لفهم مكونات XML و VADL.
- انقر احفظ وانشر لنشر API المدمج.
يمكنك الوصول إلى REST API أعلاه واختبارها من أي تطبيق خارجي باستخدام عنوان URL التالي.
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
ملاحظات أن عنوان URL أعلاه هو مثال ، وسيتعين عليك تحديد نقطة النهاية وفقًا لمثيل CRM الخاص بك.
هل تعلم؟
يمكن استخدام البيانات أعلاه للعرض كقائمة على صفحة مخصصة أو استخدامها في مخطط شريطي ونتائج ديناميكية أخرى باستخدام مكونات جافا سكريبت لتحديد واجهات برمجة التطبيقات الخاصة بك. يمكن أيضًا الوصول إلى جميع واجهات برمجة تطبيقات REST المخصصة المضمنة في API Designer باستخدام واجهات برمجة تطبيقات VTAP Javascript.
لمعرفة المزيد حول إنشاء واجهات برمجة تطبيقات مخصصة و VTAP ، تحقق من وثائق VTAP.
