استخدام acurl

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

توفّر الأداة المساعدة acurl⁽¹⁾ برنامج تضمين مناسبًا حول الأمر العادي curl. acurl:

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

يمكنك استخدام رموز الدخول لاستدعاء نقاط نهاية Edge API باستخدام 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

المكان:

على سبيل المثال:

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 العادية:

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

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

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