תחילת העבודה

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

אתם משתמשים חדשים ב- Google Cloud? אנחנו ממליצים לכם ליצור חשבון, להתנסות בעצמכם במוצרים שלנו ולבחון אותם באמצעות תרחישים ממשיים. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300 $להרצה, לבדיקה ולפריסה של עומסי העבודה.

יצירת פרויקט ב- Google Cloud

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

פרויקט יכול להכיל מגוון רחב של משאבים, כולל מפתחות API, לקוחות OAuth, חשבונות שירות, מכונות וירטואליות של Compute Engine, קטגוריות של Cloud Storage ומערכי נתונים של BigQuery. כשאפליקציה שולחת קריאה ל-API של Google Cloud , הפרויקט שבבעלותו פרטי הכניסה של האפליקציה נקרא פרויקט הלקוח, והפרויקט שבבעלותו משאב המטרה נקרא פרויקט המשאב. בקשות API מסוימות יכולות לגעת בכמה משאבים, ובמקרה כזה יכול להיות שיותר מפרויקט משאבים אחד יהיה מעורב בבקשה.

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

ממשקי API לחיפוש

לפני שמשתמשים בממשקי API של Google Cloud , כדאי להשתמש בספריית ה-API במסוף Google Cloud כדי לעיין בממשקי ה-API הזמינים שלGoogle Cloud ולמצוא את אלה שהכי מתאימים לצרכים העסקיים שלכם.

הפעלת ממשקי API

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

כדי להפעיל API, צריך לאשר את התנאים וההגבלות ואת האחריות לחיוב על ה-API. כדי להפעיל ממשקי API, אתם צריכים את ההרשאה serviceusage.services.enable בפרויקט.

בנוסף, השירות שרוצים להפעיל צריך להיות ציבורי, או שהבעלים של השירות צריך לתת למשתמש את ההרשאה servicemanagement.services.bind בשירות הפרטי. מידע נוסף מופיע במאמר בקרת גישה ב-Service Management API.

כדי להפעיל API לפרויקט באמצעות המסוף:

  1. נכנסים לדף Google Cloud API Library במסוף.
  2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים להשתמש בו.
  3. בספריית ה-API, בוחרים את ה-API שרוצים להפעיל. אם אתם צריכים עזרה בחיפוש ה-API, השתמשו בשדה החיפוש ובמסננים.
  4. בדף ה-API, לוחצים על ENABLE.

באותו דף אפשר גם להשבית ממשק API בפרויקט אם אתם לא משתמשים בו יותר, כדי למנוע שימוש לרעה וחיובים מקריים. אפשר גם להפעיל ולהשבית ממשקי Cloud API באמצעות ה-CLI של gcloud ו-Service Usage API:

gcloud services enable pubsub.googleapis.com
gcloud services disable pubsub.googleapis.com

הפעלת חיוב

חלק מממשקי ה-Cloud API מחייבים על השימוש. כדי להתחיל להשתמש בממשקי ה-API האלה בפרויקט, צריך להפעיל את החיוב בפרויקט. השימוש ב-API בפרויקט מחויב בחשבון לחיוב שמשויך לפרויקט.

אם אין לכם חשבון לחיוב, אתם יכולים ליצור אחד בעזרת ההוראות בדף החיוב במסוףGoogle Cloud . ואז לקשר את החשבון לחיוב לפרויקט.

אימות ממשקי API

האופן שבו מבצעים אימות ל-API משתנה בהתאם לסביבת הפיתוח ולשיטות האימות שבהן ה-API תומך.

הגדרת Application Default Credentials לשימוש במגוון סביבות היא הגישה הנפוצה ביותר, ומומלצת לרוב האפליקציות. אם ה-API תומך במפתחות API, זו אפשרות נוספת. אם האפליקציה צריכה לגשת למשאבים ב-Cloud שבבעלות משתמשי הקצה, צריך ליצור מזהה לקוח ב-OAuth 2.0 ולהשתמש בספריות האימות.

למידע כללי על אימות, קראו את המאמר אימות ב-Google.

פיתוח אפליקציות

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

במדריכים המפורטים הבאים מוסבר איך להשתמש בספריות הלקוח של כמה ממשקי API פופולריים:

מידע נוסף זמין במאמר הסבר על ספריות לקוח.

מידע נוסף