المحتويات

المقدمة

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

المتطلبات

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

التكوين

1.إنشاء مفتاح API الخاص بك

2.إنشاء رمز مميز للوصول إلى API

3.إدارة قوائم الوجهة

الحصول على جميع قوائم الوجهة

الحصول على كل الوجهات ضمن قائمة الوجهة

إنشاء قائمة وجهة جديدة

إضافة وجهات إلى قائمة الوجهة

حذف قائمة الوجهة

حذف وجهات من قائمة الوجهة

استكشاف الأخطاء وإصلاحها

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

المقدمة

يوضح هذا المستند كيفية إدارة قوائم الوجهة عبر الارتباط باستخدام واجهة برمجة تطبيقات الوصول الآمن.

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

المتطلبات

توصي Cisco بأن تكون لديك معرفة بالمواضيع التالية:

- الوصول الآمن

- واجهة برمجة تطبيقات الوصول الآمن

- تجعد

- جسون

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

تستند المعلومات الواردة في هذا المستند إلى إصدارات البرامج والمكونات المادية التالية:

- الوصول الآمن

- واجهات برمجة التطبيقات الخاصة بالوصول الآمن

- تجعد

- جسون

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

التكوين

1.إنشاء مفتاح API الخاص بك

انتقل إلى لوحة معلومات الوصول الآمن.

- انقر فوق Admin > Api Keys > Add

إنشاء مفتاح واجهة برمجة التطبيقات 1

إنشاء مفتاح واجهة برمجة التطبيقات 2

- إضافة API Key Name ، Description (Optional) ، Expiry Dateحسب الحاجة

إنشاء مفتاح API 3

- من تحت Key Scope، أختر Policies ثم قم بتوسيع السياسات

- إختارا Destination Lists و Destinations

- تغيير Scope إذا لزم الأمر، وإلا احتفظ ك Read/Write

- انقر فوق CREATE KEY

إنشاء مفتاح واجهة برمجة التطبيقات 4

- انسخ API Keyو Key Secret ثم انقر فوق ACCEPT AND CLOSE

إنشاء مفتاح واجهة برمجة التطبيقات 5

ملاحظة: هناك فرصة واحدة فقط لنسخ سر واجهة برمجة التطبيقات (API) الخاص بك. لا يقوم الوصول الآمن بحفظ سر واجهة برمجة التطبيقات (API) ولا يمكنك إسترداده بعد إنشائه الأولي.

2.إنشاء رمز مميز للوصول إلى API

لإنشاء الرمز المميز للوصول إلى واجهة برمجة التطبيقات، قم بإجراء طلب تفويض الرمز المميز:

طلب تفويض الرمز المميز

أستخدم بيانات اعتماد واجهة برمجة تطبيقات Secure Access API التي قمت بإنشائها لمؤسستك لإنشاء رمز مميز للوصول إلى واجهة برمجة التطبيقات.

- في العينة المجعدة، استبدل مفتاح واجهة برمجة تطبيقات Secure Access (الوصول الآمن) والسر

curl --user key:secret --request POST --url https://api.sse.cisco.com/auth/v2/token -H Content-Type: application/x-www-form-urlencoded -d grant_type=client_credentials

- نسخ الرمز المميز لواجهة برمجة التطبيقات (API) الذي تم إنشاؤه لحاملها وحفظه

ملاحظة: تنتهي صلاحية الرمز المميز للوصول الآمن إلى الإصدار 2.0 في ساعة واحدة (3600 ثانية). من المستحسن عدم تحديث الرمز المميز للوصول حتى تنتهي صلاحية الرمز المميز تقريبا.

3.إدارة قوائم الوجهة

هناك طرق متعددة لإدارة قوائم الوجهة التي تتضمن:

الحصول على جميع قوائم الوجهة

فتح موجه أوامر Windows أو وحدة Mac terminal لتشغيل الأمر:

curl -L --location-trusted --request GET --url https://api.sse.cisco.com/policies/v2/destinationlists -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json"

قصاصة من إخراج نموذج:

{"id":23456789,"organizationId":1234567,"access":"none","isGlobal":false,"name":" Test Block list","thirdpartyCategoryId":null,"createdAt":1694070823,"modifiedAt":1702819637,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":2,"meta": {"destinationCount":2,"domainCount":2,"urlCount":0,"ipv4Count":0,"applicationCount":0}

دون DestinationListId الذي يتم إدراجه ضمن حقل id" من الإخراج الذي يتم إستخدامه بشكل إضافي لطلبات GET أو POST أو DELETE المحددة لقائمة الوجهة هذه.

الحصول على كل الوجهات ضمن قائمة الوجهة

- الحصول على destinationListId خطوة ذكر السابقة هذه، الحصول على جميع قوائم الوجهة

فتح موجه أوامر Windows أو وحدة Mac terminal لتشغيل الأمر:

curl -L --location-trusted --request GET --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId/destinations -H "Authorization: Bearer YourAccessToken"

نموذج الإخراج:

{"status":{"code":200,"text":"OK"},"meta":{"page":1,"limit":100,"total":3},"data": [ {"id":"415214","destination":"cisco.com","type":"domain","comment":null,"createdAt":"2024-02-20 09:15:46"},{"id":"7237895","destination":"www.cisco.com","type":"domain","comment":null,"createdAt":"2024-02-20 10:19:51"},{"id":"29275814","destination":"10.10.10.10","type":"ipv4","comment":null,"createdAt":"2024-02-20 09:15:46"},{"id":"71918495","destination":"www.subdomain.cisco.com/resoucre","type":"url","comment":null,"createdAt":"2024-02-20 10:29:02"} ]}

إنشاء قائمة وجهة جديدة

فتح موجه أوامر Windows أو وحدة Mac terminal لتشغيل الأمر:

curl -L --location-trusted --request POST --url https://api.sse.cisco.com/policies/v2/destinationlists -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -H "Accept: application/json" -d "{\"access\":\"none\",\"isGlobal\":false,\"name\":\"Destination List Name\"}"

ملاحظة: استبدلت 'غاية قائمة الاسم' مع الاسم المرغوب.

نموذج الإخراج:

{"id":23456789,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708417690,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta":{"destinationCount":0}}

إضافة وجهات إلى قائمة الوجهة

- الحصول على destinationListId خطوة ذكر السابقة هذه، الحصول على جميع قوائم الوجهة

فتح موجه أوامر Windows أو وحدة Mac terminal لتشغيل الأمر:

curl -L --location-trusted --request POST --url https://api.sse.cisco.com/policies/v2/destinationlists/{destinationListId}/destinations -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -d "[{\"destination":"cisco.com\"},{\"destination\":\"10.10.10.10\"},{\"destination\":\"www.subdomain.cisco.com\/resource\"}]"

نموذج الإخراج:

{"status":{"code":200,"text":"OK"},"data":{"id":17804929,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708420546,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta": {"destinationCount":3}}}

حذف قائمة الوجهة

- الحصول على destinationListId خطوة ذكر السابقة هذه، الحصول على جميع قوائم الوجهة

فتح موجه أوامر Windows أو وحدة Mac terminal لتشغيل الأمر:

curl -L --location-trusted --request DELETE --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId -H "Authorization: Bearer YourAccessToken"

نموذج الإخراج:

{"status":{"code":200,"text":"OK"},"data":[]}

حذف وجهات من قائمة الوجهة

- الحصول على destinationListId خطوة ذكر السابقة هذه، الحصول على جميع قوائم الوجهة

- الحصول id على الوجهة المحددة داخل القائمة التي يجب حذفها باستخدام هذه الخطوة السابقة، الحصول على جميع الوجهات داخل قائمة الوجهة

فتح موجه أوامر Windows أو وحدة Mac terminal لتشغيل الأمر:

curl -L --location-trusted --request DELETE --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId/destinations/remove -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -H "Accept: application/json" -d "[id1,id2]"

نموذج الإخراج:

{"status":{"code":200,"text":"OK"},"data":{"id":17804929,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708525645,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta":{"destinationCount":2}}}

استكشاف الأخطاء وإصلاحها

تستخدم نقاط النهاية ل Secure Access API رموز إستجابة HTTP للإشارة إلى نجاح طلب API أو فشله. بشكل عام، تشير الرموز الموجودة في نطاق 2xx إلى النجاح، وتشير الرموز الموجودة في نطاق 4xx إلى خطأ نتج عن المعلومات المتوفرة، وتشير الرموز الموجودة في نطاق 5xx إلى أخطاء في الخادم. يعتمد النهج المتبع لحل هذه المسألة على رمز الاستجابة الذي يتم تلقيه:

REST API - رموز الاستجابة 1

REST API - رمز الاستجابة 2

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

- حدود واجهة برمجة التطبيقات للوصول الآمن

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

- دليل مستخدم Cisco Secure Access

- الدعم الفني والتنزيلات من Cisco

- إضافة مفاتيح واجهة برمجة تطبيقات الوصول الآمن

- دليل مستخدم المطورين