שימוש ב-acurl

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

כלי העזר acurl(1) מספק wrapper של פקודת 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 מפורטת הרשימה המלאה של נקודות הקצה.
USERNAME אופציונלי. צריך שילוב של שם משתמש וסיסמה או קוד סיסמה. שם המשתמש שלך ב-Apigee, שהוא בדרך כלל כתובת האימייל המשויכת לחשבון Apigee שלך. בפעם הראשונה שתתקשרו אל get_token, תצטרכו להזין את שם המשתמש או קוד הגישה שלכם. לא יהיה צורך להעביר את כתובת האימייל שלך שוב עד שיפוג התוקף של אסימוני הגישה והרענון. אם בחרת לשמור אסימונים במטמון של יותר ממשתמש אחד, צריך לציין את שם המשתמש בכל קריאה.
PASSWORD אופציונלי. צריך שילוב של שם משתמש וסיסמה או קוד סיסמה. הסיסמה של חשבון Apigee שלך. אם תשמיט את הסיסמה, תופיע בקשה להזין אותה בפעם הראשונה שתשתמש ב-acurl, ובכל הקריאות הבאות ללא אסימון רענון חוקי. אם אינך רוצה להשתמש בסיסמה ישירות בפקודה, אפשר להשתמש בקוד סיסמה חד-פעמי במקום בסיסמה.
MFACODE אופציונלי קוד זמני של אימות רב-שלבי (MFA) בן שש ספרות. הקוד הזה נדרש אם משתמשים ב--u ומופעלת בו MFA. אם הושמט (אלא אם מגדירים קוד סיסמה), תוצג הודעה. אם MFA לא מופעל, או אם יש לך תהליך סקריפט, ניתן לציין -m "" כדי להימנע מבקשות.
PASSCODE אופציונלי. צריך שילוב של שם משתמש וסיסמה או קוד סיסמה. קוד סיסמה חד-פעמי שאפשר להשתמש בו במקום הסיסמה. יש להזין קוד גישה כשמתבצע אימות באמצעות IdP של SAML, וניתן להשתמש בו כדי לאמת באמצעות 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

בנוסף לאפשרויות שמוצגות למעלה, ניתן להשתמש בכל האפשרויות של curl באמצעות acurl. לדוגמה, אפשר להעביר כותרות, לציין את פועל ה-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 מחזירה תוצאות בהתאם לנקודת הקצה של ה-API של Edge שאליה התקשרת. כמו כן, acurl שומר גם את אסימוני הגישה וגם את אסימוני הרענון ב-~/.sso-cli.

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

העברה מ-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.

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


(1) זכויות יוצרים 2023 Google LLC
הכלי acurl זמין כ "תוכנה" בהתאם להסכם המסדיר את השימוש שלך ב-Google Cloud Platform, כולל התנאים הספציפיים לשירות, הזמינים בכתובת https://cloud.google.com/terms/service-terms.