این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

استفاده از acurl

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

ابزار acurl ⁽¹⁾ یک پوشش راحت در اطراف یک فرمان استاندارد curl فراهم می کند. acurl :

اعتبارنامه Apigee شما را با یک توکن دسترسی OAuth2 مبادله می کند.
تشخیص می‌دهد که یک نشانه دسترسی منقضی شده است، و از نشانه تازه‌سازی برای دریافت رمز دسترسی جدید استفاده می‌کند.
آن نشانه را در سرصفحه Authorization درخواست API منتقل می کند.

از نشانه‌های دسترسی برای فراخوانی نقاط پایانی Edge API با OAuth2 ، از جمله گردش‌های کاری LDAP و SAML استفاده می‌کنید.

اگر از OAuth2 برای دسترسی به Edge API استفاده می‌کنید، اما از acurl استفاده نمی‌کنید، باید یک نشانه دسترسی دریافت کنید و خودتان آن را به هدر درخواست API اضافه کنید. یکی از راه‌های دریافت توکن دسترسی، استفاده از ابزار get_token است.

acurl را نصب کنید

قبل از اینکه بتوانید از acurl استفاده کنید، باید آن را نصب کنید .

نحو acurl

ابزار acurl از نحو زیر استفاده می کند:

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

یا

acurl API_URL -p PASSCODE

کجا:

گزینه	مورد نیاز؟	توضیحات
`API_URL`	مورد نیاز	نقطه پایانی Apigee Edge API. برای فهرست کامل نقاط پایانی، به Apigee Edge API Reference مراجعه کنید.
`USERNAME`	اختیاری. ترکیب نام کاربری و رمز عبور یا رمز عبور مورد نیاز است.	نام کاربری Apigee شما، که معمولاً آدرس ایمیل مرتبط با حساب Apigee شما است. اولین باری که با `get_token` تماس می گیرید، باید نام کاربری یا رمز عبور خود را ارسال کنید. تا زمانی که توکن های دسترسی و بازخوانی منقضی نشده باشند، دیگر نیازی به ارسال آدرس ایمیل خود ندارید. اگر توکن‌هایی را برای بیش از یک کاربر ذخیره می‌کنید، باید نام کاربری خود را در هر تماس مشخص کنید.
`PASSWORD`	اختیاری. ترکیب نام کاربری و رمز عبور یا رمز عبور مورد نیاز است.	رمز عبور حساب Apigee شما. اگر رمز عبور را حذف کنید، اولین باری که از `acurl` استفاده می‌کنید و در تماس‌های بعدی بدون رمز تازه‌سازی معتبر، از شما خواسته می‌شود آن را وارد کنید. اگر نمی خواهید رمز عبور خود را مستقیماً در دستور استفاده کنید، می توانید به جای رمز عبور از یک رمز عبور یکبار مصرف استفاده کنید.
`MFACODE`	اختیاری	کد احراز هویت چند عاملی (MFA) شش رقمی موقت. اگر `-u` استفاده می کنید و MFA را فعال کرده اید، این کد مورد نیاز است. در صورت حذف از شما خواسته می شود (مگر اینکه در حالت رمز عبور). اگر MFA را فعال نکرده‌اید، یا یک جریان اسکریپتی دارید، می‌توانید `-m ""` را برای جلوگیری از درخواست‌ها مشخص کنید.
`PASSCODE`	اختیاری. ترکیب نام کاربری و رمز عبور یا رمز عبور مورد نیاز است.	یک رمز عبور یک بار مصرف که می توانید به جای رمز عبور استفاده کنید. هنگام احراز هویت با SAML IDP، یک رمز عبور لازم است، و ممکن است برای احراز هویت با یک 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 استاندارد، پرگویی را فعال کنید:

گزینه	`acurl meaning`	`curl meaning`
-u	`username`	`username`
-m	`MFA code`	`max time` (باید از فرم طولانی `--max-time` استفاده شود)
-ص	`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 ذخیره می‌کند.

همانطور که در انقضای Token توضیح داده شده است، می‌توانید بدون وارد کردن اعتبار (گذرواژه و MFA اختیاری، یا رمز عبور) به برقراری تماس ادامه دهید تا زمانی که نشانه دسترسی و رمز بازخوانی منقضی شود.

مهاجرت از curl

اگر از curl استفاده می کنید، انتقال به ابزار acurl ساده است و نیازی به رمزگذاری دستی اعتبارنامه ها را از بین می برد. پس از دانلود و نصب ابزار، می توانید جایگزین کنید:

curl -u username

با:

acurl -u username

ابزار acurl اعتبار شما را رمزگذاری می‌کند و گهگاه از شما می‌خواهد اعتبارنامه‌های اضافی مورد نیاز برای به دست آوردن جفت‌های رمز جدید را دریافت کنید.

ابزار acurl همچنین می تواند برای جایگزینی curl برای کاربران ماشین استفاده شود. برای اطلاعات بیشتر، OAuth2 را برای کاربران ماشین و کاربران ماشین در مناطق SAML ببینید.

برای اولین بار با acurl تماس بگیرید

اولین باری که API را با acurl تماس می‌گیرید، اعتبارنامه Apigee خود را (نام کاربری و رمز عبور حساب Apigee یا یک رمز عبور) ارائه می‌کنید تا acurl بتواند آنها را با یک نشانه دسترسی مبادله کند و توکن تازه‌سازی کند.

مثال زیر یک تماس اولیه با acurl را برای دریافت جزئیات یک سازمان با استفاده از نقطه پایان سازمان Get نشان می دهد:

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 به طور خودکار از توکن refresh برای دریافت توکن دسترسی جدید استفاده می کند. وقتی توکن به‌روزرسانی منقضی شد، acurl از شما می‌خواهد اعتبارنامه Apigee خود را دریافت کنید.

این درخواست جزئیاتی در مورد سازمان "ahamilton-eval" دریافت می کند. برای فهرست کامل نقاط پایانی Edge API، به Apigee Edge API Reference مراجعه کنید.

⁽¹⁾ حق چاپ 2023 Google LLC
ابزار acurl به‌عنوان «نرم‌افزار» تحت توافقنامه حاکم بر استفاده شما از پلتفرم Google Cloud، از جمله شرایط خاص سرویس که در https://cloud.google.com/terms/service-terms موجود است، در دسترس است.