תחילת העבודה

בדף הזה מוסבר איך מפתחים יכולים להתחיל להשתמש בממשקי API של Cloud de Confiance by S3NS .

אם אתם משתמשים בממשקי API בפעם הראשונה, אתם יכולים לפעול לפי השלבים במדריך הזה כדי להפעיל את ממשקי ה-API באמצעות פקודות curl. Cloud de Confiance אפשר להשתמש בפקודות curl כדי להתנסות ב-API לפני שמפתחים את האפליקציה.

יצירת S3NS פרויקט

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

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

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

Discovering APIs

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

הפעלת ממשקי API

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

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

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

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

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

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

הפעלת חיוב

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

אימות ממשקי API

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

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

למידע כללי על אימות, תוכלו לעיין במאמר בנושא אימות ב-Google.

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

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

מידע נוסף