المحتويات

المقدمة

المتطلبات الأساسية

المتطلبات

المكونات المستخدمة

وثائق واجهة برمجة التطبيقات (API) على AccessBoard

إختبار واجهات برمجة التطبيقات من أداة التوثيق

معلومات ذات صلة

المقدمة

يوضح هذا المستند كيفية التحقق من صحة إستدعاءات REST API وتكوينها ل vManage من خلال إستخدام الوثائق المدمجة.

المتطلبات الأساسية

المتطلبات

لا توجد متطلبات خاصة لهذا المستند.

المكونات المستخدمة

لا يقتصر هذا المستند على إصدارات برامج معينة أو أنواع نشر vManage.

تم إنشاء المعلومات الواردة في هذا المستند من الأجهزة الموجودة في بيئة معملية خاصة. بدأت جميع الأجهزة المُستخدمة في هذا المستند بتكوين ممسوح (افتراضي). إذا كانت شبكتك قيد التشغيل، فتأكد من فهمك للتأثير المحتمل لأي أمر.

الوصول إلى وثائق واجهة برمجة التطبيقات (API) المدمجة

توجد وثائق VManage الخاصة بواجهة برمجة التطبيقات على عنوان URL https://<vmanage_ip>:<port:>/apidocs.  تعرض هذه الوثائق واجهات برمجة التطبيقات المتاحة على إصدار البرنامج الحالي.

وهذا يتطلب تسجيل الدخول باستخدام بيانات اعتماد vManage صالحة.  بينما يمكن لمستويات الامتيازات المتعددة عرض الوثائق، يمكن فقط لمستخدم NetAdmin تنفيذها جميعها.

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

ثم يعرض vManage قائمة بفئات واجهات برمجة التطبيقات (API) المتاحة.  انقر الفئة المرغوبة، متبوعة باستدعاء API نفسه، والذي يعرض هذه الحقول:

الوصف/ملاحظات التنفيذ

وصف العملية التي تم تنفيذها.

محددات

المعلمات المطلوبة التي سيتم تحديدها لاستدعاء API.

نص الطلب (POST/PUT/DELETE)

تنسيق نص الطلب.

الاستجابات

الردود المحتملة التي يرسلها vManage إلى واجهة برمجة التطبيقات. وهذا يتضمن رمز حالة HTTP، والسبب، ونص الاستجابة المحتملة.

الامتدادات

ملحقات صالحة للاستدعاء.

إختبار واجهات برمجة التطبيقات من أداة التوثيق

يمكن إختبار واجهات برمجة التطبيقات (API) المتوفرة من خلال خيار تجربة ذلك.

ملاحظة: كن على علم بأن هذه ليست محاكاة. يتم تنفيذ المكالمة بالفعل على vManage المحلي.  قم بالتخطيط لأي تأثير مرتبط وفقا لذلك.

1. انقر فوق الزر Try It Out .

2. إدخال كافة المعلمات المطلوبة.

3. انقر على تنفيذ.

يقوم هذا الأمر بتنفيذ مهمة واجهة برمجة التطبيقات (API)، وإرجاع الاستجابة التي تم تلقيها من vManage، والتي تتضمن الحقول التالية:

عنوان URL للطلب

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

هيئة الاستجابة

بيانات الاستجابة الكاملة التي تم تلقيها.

رمز الاستجابة

تم تلقي رمز حالة HTTP.

رؤوس الاستجابات

الرؤوس المستخدمة.

معلومات ذات صلة

وثائق واجهة برمجة التطبيقات Cisco Developer vManage