תחילת השימוש ב-Apigee API

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

אפשר להשתמש ב-Apigee API כדי לפתח ולנהל ממשקי API באופן פרוגרמטי באמצעות קבוצה של פעולות RESTful.

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

מידע נוסף זמין במאמר בנושא Apigee API.

הפעלת Apigee API

מוודאים שהפעלתם את Apigee API. הדרך הפשוטה ביותר להפעיל API בפרויקט היא באמצעות ממשק המשתמש של Apigee. פרטים מלאים זמינים במאמר בנושא שלב 1: הפעלת ממשקי API נדרשים.

קבלת אסימון גישה מסוג OAuth 2.0

ממשק Apigee API תומך ב-OAuth 2.0 לאימות משתמשים. באמצעות OAuth 2.0, אתם מחליפים את פרטי הכניסה שלכם ב-Google Cloud באסימון גישה, שבו אתם יכולים להשתמש כדי לבצע קריאות מאובטחות ל-Apigee API. אחרי שמקבלים טוקן, לא צריך להחליף את פרטי הכניסה שוב עד שתוקף הטוקן יפוג.

קבלת אסימון באמצעות פרטי כניסה ל-Google Cloud

כדי לקבל אסימון באמצעות פרטי הכניסה שלכם ל-Google Cloud:

נותנים ל-gcloud הרשאה לגשת ל-Cloud Platform באמצעות פרטי הכניסה של המשתמש ב-Google:
```
gcloud auth login
```

קבלת טוקן לחשבון הפעיל:

export TOKEN=$(gcloud auth print-access-token)

כשמפעילים Apigee API, מעבירים את אסימון הגישה בכותרת Authorization. לדוגמה:
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"
```

קבלת אסימון באמצעות מפתח של חשבון שירות ב-Google Cloud

כדי לקבל אסימון באמצעות מפתח של חשבון שירות לצורך הרשאה:

יוצרים מפתח לחשבון השירות באמצעות Google Cloud המסוף, כמו שמתואר במאמר יצירה וניהול של מפתחות לחשבונות שירות.
קובץ JSON שמכיל את פרטי הכניסה של חשבון השירות יורד למחשב שלכם.
מגדירים את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS לנתיב שבו נמצא המפתח של חשבון השירות:
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```
כשמפעילים Apigee API, משתמשים ב-Google Cloud CLI כדי להוסיף אסימון גישה לכותרת Authorization. לדוגמה:
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"
```

הגדרת משתני סביבה לבקשות Apigee API

בדוגמאות ל-Apigee API ול-CLI של gcloud שמופיעות במאמרי עזרה אלה נעשה שימוש באחד או יותר ממשתני הסביבה שמוגדרים בטבלה הבאה.

אם מגדירים מראש את משתני הסביבה לערכים משמעותיים בסביבה שלכם, אפשר להעתיק ולהדביק את בקשות הדוגמה כדי להריץ אותן בסביבה שלכם עם שינויים מינימליים או ללא שינויים בכלל.

משתנה הסביבה	תיאור
`$API`	השם של ה-proxy ל-API.
`$APIPRODUCT`	שם מוצר ה-API.
`$APP`	מזהה של אפליקציה.
`$DEVELOPER_EMAIL`	כתובת האימייל של המפתח.
`$ENV`	שם הסביבה, למשל `test` או `prod`.
`$ID`	מזהה המשאב.
`$KEY`	טוקן צרכן.
`$NAME`	השם של המשאב.
`$ORG`	הארגון שלכם ב-Apigee.
`$REV`	מספר הגרסה של ה-proxy ל-API.
`$SHAREDFLOW`	השם של התהליך המשותף.
`$TYPE`	סוג המשאב.

שימוש ב-curl

בדוגמאות שבקטע הזה נעשה שימוש ב-curl כדי להדגים איך לפתח אפליקציות באמצעות Apigee API. ‫curl הוא כלי שורת פקודה בקוד פתוח להעברת נתונים עם תחביר של כתובת URL, והוא תומך בפרוטוקולים נפוצים כמו HTTP ו-HTTPS.

בטבלה הבאה מפורטות האפשרויות של שורת הפקודה curl שבהן נעשה שימוש בדוגמאות.

אפשרות	תיאור
`-d '{}' --data @filename --data-binary @filename`	מגדיר את גוף הבקשה, שאפשר להעביר ישירות או על ידי ציון שם קובץ.
`-F file=@filename --form file=@filename`	מגדיר נתונים מבוססי-טופס שאפשר להעביר על ידי ציון שם קובץ.
`-H --header`	מגדיר כותרת הבקשה. צריך להעביר את הפרטים הבאים בכותרת הבקשה: כותרת `Authorization`: אסימון OAuth 2.0 לאימות משתמש, כפי שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0. כותרת `Content-Type`: סוג התוכן של גוף הבקשה שנשלח כשיוצרים או מעדכנים משאב (POST, ‏ PATCH, ‏ PUT) באמצעות ה-API.
`-X`	מציין את סוג הבקשה (GET,‏ POST וכו').

לדוגמה:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0.