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

שימוש ב-acurl

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

הכלי acurl⁽¹⁾ מספק wrapper נוחות סביב 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`	אופציונלי	רב-גורמים זמניים בני 6 ספרות אימות (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`)
-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.

אפשר להמשיך לבצע שיחות בלי להזין פרטי כניסה (סיסמה ו-MFA אופציונליים, או קוד גישה) עד שגם אסימון הגישה וגם התוקף של אסימון הרענון יפוג, כפי שמתואר במאמר תפוגת האסימון.

העברה מ-Curl

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

curl -u username

עם:

acurl -u username

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

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

התקשרות אל כתובת האתר בפעם הראשונה

בפעם הראשונה שתפעילו את ה-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 ישתמש באופן אוטומטי באסימון הרענון כדי לקבל אסימון גישה חדש. כשיפוג התוקף של אסימון הרענון, acurl יציג לך הנחיה בפרטי הכניסה שלכם ל-Apigee.

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

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