تكوين ساعي البريد لتنفيذ واجهات برمجة التطبيقات على vManage

المقدمة

يوضح هذا المستند كيفية تنفيذ واجهات برمجة التطبيقات (APIs) باستخدام PostMan.

متطلبات النظام

• تم تثبيت ساعي البريد
• الوصول إلى بيانات اعتماد vManage واسم المستخدم وكلمة المرور

ملاحظة إذا كنت لا تمتلك ساعي بريد، قم بتنزيله من https://www.postman.com/downloads/

معلومات أساسية

إن أفعال HTTP الأساسية أو الأكثر إستخداما (أو الطرق، كما تسمى بشكل صحيح) هي POST و GET و PUT و PATCH و DELETE.

هذه المرادفة لإنشاء عمليات (أو CRUD) وقراءتها وتحديثها وحذفها على التوالي.

هناك عدد من الأفعال الأخرى أيضا، لكنها تستخدم بشكل أقل تواترا. ومن بين تلك الطرق الأقل تواترا، تستخدم الخيارات والرؤوس أكثر من غيرها.

تكوين ساعي البريد لتنفيذ واجهات برمجة التطبيقات

الخطوة 1. افتح ساعي البريد وقم بإنشاء طلب HTTP جديد.

يمكنك إنشاء طلبات HTTP جديدة إذا قمت بالنقر في أي من الخيارات المبرزة.

إنشاء طلب HTTP جديد.

الخطوة 2. قم بالمصادقة باستخدام بيانات اعتماد اسم المستخدم وكلمة المرور إلى vManage.

إنشاء طلب HTTP آخر.

1. حدد POST كفعل HTTP.
2. إضافة https://<vmanage-ip>/j_security_checknext to POST.
3. طقطقت نص وأضفت ك مفتاح معلم j_usernameو j_password وقيمهم على التوالي.
4. طقطقة يرسل.

ملاحظة: في هذا المثال، عنوان VManage IP هو 10.88.244.30 والمنفذ هو 5301

ملاحظة: كقيم اسم مستخدم وكلمة مرور، نستخدم المسؤول.

سجل المعاملات في Postman.

إدارة المصادقة.

تحذير: يجب أن تكون إستجابة إستدعاء API هذا فارغة

الخطوة 3. طلب رمز مميز

1. حدد GET كفعل HTTP.
2. إضافة تفاصيل إستدعاء واجهة برمجة التطبيقات التالية للحصول على https://<vmanage-ip>/dataService/client/token
3. طقطقة يرسل

ملاحظة: منذ إصدار vManage 19.2.1، أصبح إلزاميا أن يحتاج المستخدم الذي قام بتسجيل الدخول بنجاح إلى إرسال الرمز المميز X-XSRG أو الرمز المميز CSRF لكل عملية POST/PUT/DELETE عبر إستدعاء واجهة برمجة التطبيقات (API).

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

طلب رمز مميز ل vManage

تحذير: إذا لم تحصل على رمز مميز كما هو موضح في الصورة، فيرجى تكرار الخطوة.

الخطوة 4. قم بالمتابعة لتنفيذ واجهة برمجة تطبيقات أخرى ل vManage.

يتضمن هذا المثال طلب POST

1. حدد إستدعاء واجهة برمجة التطبيقات المطلوب تنفيذها، في حالتنا هي https:///dataservice/statistics/dpi/aggregation

تلميح: إذا كنت ترغب في أستكشاف مكالمات API الأخرى، فيرجى الانتقال إلى عنوان URL vManage https://vmanage-ip:port/apidocs

2. اجمع جهاز الاتصال لواجهة برمجة التطبيقات (API).

ملاحظة: يحتوي إستدعاء واجهة برمجة التطبيقات هذا على نص بتنسيق JSON

3. انقر فوق رأس وأضف مفتاح السلسلة X-XSRF-TOKEN كقيمة.

4. انقر فوق إرسال.

تعرض الصورة المعروضة كيفية ظهور إستدعاء واجهة برمجة التطبيقات (API).

إستدعاء واجهة برمجة تطبيقات تجميع DPI.

الخطوة 5. إغلاق جلسة العمل

بمجرد إسترداد جميع المعلومات المطلوبة من vManage و/أو الأجهزة، قم بتحرير موارد vManage وألغي إمكانية إستخدام المستخدمين الضارين لجلسة العمل.

تشغيل مكالمات واجهة برمجة التطبيقات في بيئة مؤتمتة

حفظ ملفات تعريف الارتباط والمتغيرات المراد إستخدامها في مكالمات API التالية

كيف يتم حفظ الرمز المميز في متغير؟

قم بحفظ الرمز المميز في متغير لإعادة الاستخدام لاحقا.

حفظ الرمز المميز في متغير

عند طلب الرمز المميز بتنسيق JSON، قم بتخزينه. أستخدم علامة التبويب إختبارات ولصق الخطوط المعروضة.

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("token", jsonData.token);

pm.test("Status code is 200", () => {
 pm.expect(pm.response.code).to.eql(200);
});