‫Google برای ترجمه محتوا به زبان ترجیحی شما از فناوری هوشواره استفاده می‌کند. ترجمه‌های هوشواره‌ای ممکن است اشتباه داشته باشند.

استفاده از 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 مراجعه کنید.
`USERNAME`	اختیاری. ترکیبی از نام کاربری و گذرواژه یا گذرنویسه لازم است.	نام کاربری Apigee شما که معمولاً نشانی ایمیل منسوب به حساب Apigee شما است. اولین‌باری که با `get_token` تماس می‌گیرید، باید نام کاربری یا گذرنویسه‌تان را وارد کنید. تا زمانی که نشان‌های دسترسی و بازآوری منقضی نشده‌اند، دیگر لازم نیست نشانی ایمیلتان را وارد کنید. اگر نشانه‌ها را برای بیش از یک کاربر ذخیره می‌کنید، باید نام کاربری خود را در هر تماس مشخص کنید.
`PASSWORD`	اختیاری. ترکیبی از نام کاربری و گذرواژه یا گذرنویسه لازم است.	گذرواژه حساب Apigee شما. اگر گذرواژه را حذف کنید، در اولین استفاده از `acurl` و در تماس‌های بعدی بدون رمز بازآوری معتبر، از شما خواسته می‌شود آن را وارد کنید. اگر نمی‌خواهید مستقیماً از گذرواژه خود در فرمان استفاده کنید، می‌توانید به‌جای گذرواژه از گذرنویسه کد یکبارمصرف استفاده کنید.
`MFACODE`	اختیاری	کد موقت شش‌رقمی اصالت‌سنجی چندعاملی (MFA). اگر از `-u` استفاده می‌کنید و «احراز هویت چند مرحله‌ای» را فعال کرده‌اید، این کد لازم است. اگر آن را وارد نکنید، از شما خواسته می‌شود آن را وارد کنید (مگر اینکه در حالت گذرنویسه باشید). اگر «احراز هویت چندعاملی» را فعال نکرده‌اید یا جریان برنامه‌ریزی‌شده‌ای دارید، می‌توانید `-m ""` را مشخص کنید تا از پیام‌واره‌ها جلوگیری کنید.
`PASSCODE`	اختیاری. ترکیبی از نام کاربری و گذرواژه یا گذرنویسه لازم است.	گذرنویسه یکبار مصرف که می‌توانید به‌جای گذرواژه از آن استفاده کنید. هنگام اصالت‌سنجی با «ارائه‌دهنده هویت» SAML، گذرنویسه لازم است و ممکن است برای اصالت‌سنجی با «ارائه‌دهنده هویت» 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` استفاده کنید)
‫-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 API که فراخوانی کرده‌اید برمی‌گرداند. علاوه‌براین، acurl هم ژتون دسترسی و هم ژتون بازآوری را در ~/.sso-cli ذخیره می‌کند.

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

انتقال از curl

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

curl -u username

با:

acurl -u username

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

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

برای اولین‌بار acurl را فراخوانی کنید

اولین‌باری که با acurl با API تماس می‌گیرید، اطلاعات اعتباری 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 را درخواست می‌کند.

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

^(۱) «حق نشر ۲۰۲۳ Google LLC»
ابزار acurl تحت قرارداد حاکم بر استفاده شما از Google Cloud Platform به‌عنوان «نرم‌افزار» دردسترس قرار می‌گیرد، ازجمله «شرایط ویژه خدمات» موجود در https://cloud.google.com/terms/service-terms.