استخدام acurl

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

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

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

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

إذا كنت تستخدم OAuth2 للوصول إلى Edge API، ولكنك لا تستخدم 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. للحصول على قائمة كاملة بنقاط النهاية، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات Apigee Edge.
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
-m MFA code max time (يجب استخدام الصيغة الطويلة --max-time)
-p passcode proxy tunnel (يجب استخدام الصيغة الطويلة --proxytunnel)
-v verbose verbose
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 التي اتصلت بها. بالإضافة إلى ذلك، يخزِّن acurl كلاً من رمزَي الدخول وإعادة التحميل في ~/.sso-cli.

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

نقل البيانات من curl

إذا كنت تستخدم 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:

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

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

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

يوفّر هذا الطلب تفاصيل حول مؤسسة "ahamilton-eval". للحصول على قائمة كاملة بنقاط نهاية واجهة برمجة تطبيقات Edge، يمكنك الاطّلاع على مرجع واجهة برمجة التطبيقات Apigee Edge.


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