הגדרת פרויקט ב- Cloud de Confiance by S3NS ואימות מאפשרים לשלוח קריאות ל-API של Cloud de Confiance מהאפליקציות שלכם. במאמר הזה נסביר איך להתחיל להשתמש בממשקי ה-API של Cloud de Confiance : איך יוצרים פרויקט, איך מוצאים ומפעילים שירותים בספריית ה-API, איך מקשרים חשבון לחיוב, איך מגדירים פרטי כניסה ואיך משתמשים בספריות הלקוח.
יצירת פרויקט ב- Cloud de Confiance
כדי להשתמש בממשקי ה-API של Cloud de Confiance , צריך חשבון משתמש (חשבוןS3NS או חשבון של ספק זהויות חיצוני) ופרויקט ב-Cloud de Confiance . פרויקט מקביל לחשבון פיתוח. הוא משמש כמכל למשאבי Cloud de Confiance . הוא גם מספק גבולות בידוד לשימוש שלכם בשירותי Cloud de Confiance by S3NS , כדי שתוכלו לנהל את מגבלות המכסות והחיוב באופן עצמאי ברמת הפרויקט. גם נתוני הטלמטריה של השימוש ולוחות הבקרה מקובצים לפי פרויקטים. אם אין לכם פרויקט, אתם יכולים ליצור פרויקט באמצעות מסוףCloud de Confiance .
פרויקט יכול להכיל מגוון רחב של משאבים, כולל מפתחות API, לקוחות OAuth, חשבונות שירות, מכונות וירטואליות של Compute Engine, קטגוריות של Cloud Storage ומערכי נתונים של BigQuery. כשאפליקציה שולחת קריאה ל-API של Cloud de Confiance , הפרויקט שבבעלותו פרטי הכניסה של האפליקציה נקרא פרויקט הלקוח, והפרויקט שבבעלותו משאב המטרה נקרא פרויקט המשאב. בקשות API מסוימות יכולות לגעת בכמה משאבים, ובמקרה כזה יכול להיות שיותר מפרויקט משאבים אחד יהיה מעורב בבקשה.
אם אתם רוצים להפסיק להשתמש ב- Cloud de Confiance מכל סיבה שהיא, אתם יכולים להשתמש במסוףCloud de Confiance כדי למחוק את הפרויקט. הפרויקט וכל המשאבים שבו יימחקו אחרי חלון השמירה. חשוב לזכור שלסוגים שונים של נתונים יש תקופות שמירה שונות.
ממשקי API לחיפוש
לפני שמשתמשים בממשקי API של Cloud de Confiance , כדאי להשתמש בספריית ה-API במסוף Cloud de Confiance כדי לעיין בממשקי ה-API הזמינים שלCloud de Confiance ולמצוא את אלה שהכי מתאימים לצרכים העסקיים שלכם.
הפעלת ממשקי API
חלק מממשקי ה-API של Cloud de Confiance מופעלים כברירת מחדל. כדי להשתמש ב-API של Cloud de Confianceשלא מופעל כברירת מחדל, צריך להפעיל אותו בפרויקט. בהתאם לשירותים ולפרויקטים שמעורבים באפליקציה, כולל פרויקט הלקוח ופרויקטים של משאבים, יכול להיות שתצטרכו להפעיל API בכמה פרויקטים. כשמפעילים API שתלוי בממשקי API אחרים, גם ממשקי ה-API האלה מופעלים באותו זמן.
כדי להפעיל API, צריך לאשר את התנאים וההגבלות ואת האחריות לחיוב על ה-API. כדי להפעיל ממשקי API, אתם צריכים את ההרשאה serviceusage.services.enable בפרויקט.
כדי להפעיל API לפרויקט באמצעות המסוף:
- נכנסים לדף Cloud de Confiance API Library במסוף.
- ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים להשתמש בו.
- בספריית ה-API, בוחרים את ה-API שרוצים להפעיל. אם אתם צריכים עזרה בחיפוש ה-API, השתמשו בשדה החיפוש ובמסננים.
- בדף ה-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 בפרויקט מחויב בחשבון לחיוב שמשויך לפרויקט.
אימות ממשקי API
האופן שבו מבצעים אימות ל-API משתנה בהתאם לסביבת הפיתוח ולשיטות האימות שבהן ה-API תומך.
הגדרת Application Default Credentials לשימוש במגוון סביבות היא הגישה הנפוצה ביותר, ומומלצת לרוב האפליקציות. אם ה-API תומך במפתחות API, זו אפשרות נוספת. אם האפליקציה צריכה לגשת למשאבים ב-Cloud שבבעלות משתמשי הקצה, צריך ליצור מזהה לקוח ב-OAuth 2.0 ולהשתמש בספריות האימות.
למידע כללי על אימות, קראו את המאמר אימות ב-Google.
פיתוח אפליקציות
אם אתם מפתחים אפליקציה באמצעות Cloud APIs, מומלץ להשתמש בCloud de Confiance ספריות לקוח אם הן זמינות. ספריות הלקוח יכולות לטפל בתכונות נפוצות של API, כמו אימות, טיפול בשגיאות, ניסיון חוזר ואימות מטען ייעודי (payload). במהלך האתחול, צריך להעביר את פרטי הכניסה של האפליקציה לספריות הלקוח, כדי שהן יוכלו לבצע קריאות לממשקי ה-API שלCloud de Confiance בשם האפליקציה.
מידע נוסף
- מידע נוסף על הפעלה והשבתה של ממשקי API זמין במאמר הפעלה והשבתה של שירותים.