استخدام acurl

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X.
معلومات

توفر الأداة acurl(1) برنامج تضمين مريح حول curl عادي الأمر. acurl:

  • استبدال بيانات اعتماد Apigee برمز الدخول OAuth2.
  • ترصد هذه القاعدة حالات انتهاء صلاحية رمز الدخول، وتستخدم الرمز المميّز لإعادة التحميل للحصول على رمز دخول جديد.
  • يشير إلى هذا الرمز المميّز في عنوان Authorization لطلب البيانات من واجهة برمجة التطبيقات.

استخدام رموز الدخول لطلب نقاط نهاية واجهة برمجة التطبيقات Edge من خلال OAuth2، بما في ذلك سير عمل LDAP وSAML.

إذا كنت تستخدم OAuth2 للوصول إلى واجهة برمجة تطبيقات Edge، ولكنك لا تستخدم acurl، يجب عليك الحصول على رمز الدخول وإضافته إلى عنوان طلب واجهة برمجة التطبيقات بنفسك. تتمثل إحدى طرق الحصول على يكون رمز الدخول باستخدام الأداة المساعدة get_token.

تثبيت acurl

قبل أن تتمكّن من استخدام "acurl"، عليك تثبيته.

بنية acurl

تستخدم الأداة acurl البنية التالية:

acurl API_URL -u USERNAME:PASSWORD [-m MFACODE]

أو

acurl API_URL -p PASSCODE

المكان:

Option مطلوب؟ الوصف
API_URL مطلوب نقطة نهاية Apigee Edge API للحصول على قائمة كاملة بنقاط النهاية، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات في Apigee Edge API.
USERNAME اختيارية. يجب إدخال اسم المستخدم وكلمة المرور أو رمز مرور. اسم مستخدم Apigee، وهو عادةً عنوان البريد الإلكتروني المرتبط بحسابك على Apigee. يجب عليك تقديم اسم المستخدم أو رمز المرور في المرة الأولى التي تتصل فيها بـ get_token. لن تحتاج إلى تمرير بريدك الإلكتروني إلى أن تنتهي صلاحية رموز الدخول والتحديث. إذا كنت تخزّن رموزًا مميّزة لأكثر من مستخدم واحد، يجب تحديد اسم المستخدم الخاص بك في كل استدعاء.
PASSWORD اختيارية. يجب إدخال اسم المستخدم وكلمة المرور أو رمز مرور. كلمة المرور لحسابك في Apigee. إذا لم تستخدم كلمة المرور، سيُطلب منك أدخِله في المرة الأولى التي تستخدم فيها acurl، وفي أي مكالمات لاحقة بدون إدخال رقم تعريف صالح الرمز المميز لإعادة التحميل. إذا لم تكن تريد استخدام كلمة المرور مباشرةً في الأمر، فيمكنك استخدام رمز مرور صالح لمرة واحدة بدلاً من كلمة المرور
MFACODE اختياريّ عوامل متعددة مؤقتة مكوّنة من ستة أرقام مصادقة (MFA). يجب إدخال هذا الرمز إذا كنت تستخدم -u وفعّلت المواقع المصممة بغرض الإعلانات (MFA). سيُطلب منك في حال تم حذفها (إلا في وضع رمز المرور). إذا لم تكن قد قمت بتفعيل مواقع MFA، أو إذا كان لديك تدفق نصي، يمكنك تحديد -m "" لتجنُّب الطلبات.
PASSCODE اختيارية. يجب إدخال اسم المستخدم وكلمة المرور أو رمز مرور. رمز مرور صالح لمرة واحدة يمكنك استخدامه بدلاً من وكلمة المرور. يجب إدخال رمز مرور عند المصادقة باستخدام موفِّر هوية (idP) SAML، وقد يتم استخدامه للمصادقة باستخدام موفِّر هوية (idP) لـ LDAP.

مثلاً:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com -p 424242
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd -m 123456

بالإضافة إلى الخيارات المعروضة أعلاه، يمكن لـ acurl قبول جميع curl الخيارات. على سبيل المثال، يمكنك تمرير العناوين وتحديد فعل HTTP وإضافة نص وتفعيل مستوى الإسهاب باستخدام خيارات curl العادية:

Option acurl meaning curl meaning
-u username username
MFA code max time (يجب استخدام النموذج الطويل --max-time)
-p passcode proxy tunnel (يجب استخدام النموذج الطويل --proxytunnel)
-v verbose verbose
-h help help (يجب استخدام النموذج الطويل --help)
acurl -v -X POST -H 'Content-Type: application/json' \
    https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apiproducts/myproduct/attributes/attr \
    -u ahamilton@apigee.com -d '{"value":42}'

يعرض طلب acurl الناجح النتائج بناءً على نقطة نهاية Edge API التي تستخدمها استدعيت. بالإضافة إلى ذلك، يخزّن acurl رمزَي الدخول وإعادة التحميل. في ~/.sso-cli.

يمكنك مواصلة إجراء المكالمات بدون إدخال بيانات الاعتماد (كلمة المرور أو رمز MFA الاختياري أو رمز المرور). حتى يتم عرض كل من رمز الدخول انتهاء صلاحية الرمز المميّز لإعادة التحميل، كما هو موضّح في انتهاء صلاحية الرمز المميّز.

نقل البيانات من الشعر

إذا كنت تستخدم curl، سيكون نقل البيانات إلى الأداة acurl عملية سهلة يلغي الحاجة إلى ترميز بيانات الاعتماد يدويًا. بعد تنزيل الأداة وتثبيتها، يمكنك استبدال:

curl -u username
عبر:
acurl -u username

ستقوم الأداة acurl بترميز بيانات الاعتماد، وسيطلب منك أحيانًا بيانات الاعتماد الإضافية المطلوبة للحصول على أزواج رموز مميّزة جديدة.

يمكن أيضًا استخدام الأداة acurl لاستبدال curl لمستخدمي الأجهزة. لمزيد من المعلومات يُرجى الاطِّلاع على OAuth2 لمستخدمي الأجهزة ومستخدمي الأجهزة في مناطق SAML.

طلب acurl لأول مرة

في المرة الأولى التي تطلب فيها واجهة برمجة التطبيقات باستخدام acurl، عليك تقديم بيانات اعتماد Apigee ( اسم المستخدم وكلمة المرور لحسابك على Apigee أو رمز مرور) حتى يمكن لتطبيق "acurl" استبدالهما برمز دخول ورمز مميز لإعادة التحميل.

يوضح المثال التالي مكالمة أولية مع acurl للحصول على تفاصيل بشأن مؤسستك باستخدام واجهة برمجة التطبيقات نقطة نهاية المؤسسة:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \
  -u ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code (no spaces) if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
1a2b3c
{
  "createdAt" : 1491854501264,
  "createdBy" : "noreply_iops@apigee.com",
  "displayName" : "ahamilton",
  "environments" : [ "prod", "test" ],
  "lastModifiedAt" : 1491854501264,
  "lastModifiedBy" : "noreply_iops@apigee.com",
  "name" : "ahamilton",
  "properties" : {
    "property" : [ {
      "name" : "features.isSmbOrganization",
      "value" : "false"
    }, {
      "name" : "features.isCpsEnabled",
      "value" : "true"
    } ]
  },
  "type" : "trial"
}

تحصل الأداة المساعدة acurl على رمز دخول وتدخله في الاتصال نقطة نهاية Edge API:

curl -H "Authorization: Bearer oauth2_access_token" ...

يتم تخزين رمز الدخول محليًا في ~/.sso-cli واستخدامه في الاتصالات اللاحقة.

بعد انتهاء صلاحية رمز الدخول، يستخدم acurl تلقائيًا الرمز المميّز لإعادة التحميل من أجل رمز دخول جديد. عند انتهاء صلاحية الرمز المميز لإعادة التحميل، سيطلب منك acurl لبيانات اعتماد Apigee.

يحصل هذا الطلب على تفاصيل حول "أهاميلتون-إيفال" التنظيم. للحصول على قائمة كاملة نقاط نهاية Edge API، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات في Apigee Edge.


(1) حقوق الطبع والنشر لعام 2023 لشركة Google LLC
أداة acurl متاحة باسم "برامج" تحت اتفاقية تحكم استخدامك لخدمة Google Cloud Platform، بما في ذلك تتوفّر "الأحكام الخاصة" على https://cloud.google.com/terms/service-terms.