استخدام 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.

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

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

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

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

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

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

استدعاء acurl للمرة الأولى

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

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

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.

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


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