דף זה תורגם על ידי Cloud Translation API.

שימוש ב-acurl

מוצג המסמך של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

הכלי acurl⁽¹⁾ מספק מעטפת נוחה לפקודה רגילה של curl. acurl:

החלפת פרטי הכניסה ל-Apigee באסימון גישה מסוג OAuth2.
זיהוי אם פג התוקף של אסימון הגישה, ושימוש באסימון הרענון כדי לקבל אסימון גישה חדש.
מעבירים את האסימון הזה בכותרת Authorization של בקשת ה-API.

אתם משתמשים באסימוני גישה כדי לקרוא לנקודות קצה (endpoint) של 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. רשימה מלאה של נקודות קצה זמינה במאמר חומר העזר בנושא API של Apigee Edge.
`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 רגילות:

אפשרות	`acurl meaning`	`curl meaning`
‎-u	`username`	`username`
‎-m	`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

אם אתם משתמשים ב-curl, ההעברה לכלי acurl היא פשוטה ומבטלת את הצורך לקודד פרטי כניסה באופן ידני. אחרי שהורדתם והתקנתם את כלי השירות, אתם יכולים החלפה:

curl -u username

עם:

acurl -u username

הכלי acurl קודד את פרטי הכניסה שלכם, ובמקרים מסוימים תתבקשו להזין את פרטי הכניסה הנוספים הנדרשים כדי לקבל זוגות אסימונים חדשים.

אפשר להשתמש בכלי העזר acurl גם כדי להחליף את curl בשביל משתמשים במכונות. למידע נוסף, ראו OAuth2 למשתמשים במכונות ומשתמשים במכונות באזורי SAML.

קריאה ל-acurl בפעם הראשונה

בפעם הראשונה שתפעילו את ה-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.

בבקשה הזו יתקבלו פרטים על "ערכת המילטון" של הארגון. לרשימה מלאה של נקודות הקצה (endpoints) של Edge API. ראו חומר העזר בנושא Apigee Edge API.

⁽¹⁾ זכויות יוצרים 2023 Google LLC
הכלי acurl זמין כ'תוכנה' בכפוף להסכם שמסדיר את השימוש שלכם ב-Google Cloud Platform, כולל התנאים הספציפיים לשירות שזמינים בכתובת https://cloud.google.com/terms/service-terms.