این صفحه به‌وسیله ‏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 API_URL -u USERNAME:PASSWORD [-m MFACODE]

یا

acurl API_URL -p PASSCODE

کجا:

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

برای مثال:

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 ، verbosity را فعال کنید:

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

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

مهاجرت از curl

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

curl -u username

با:

acurl -u username

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

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

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

اولین باری که API را با 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 Reference مراجعه کنید.

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