מדריך לשילוב

קבלת מפתח פרטי

שימוש בממשק ההצטרפות

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

יצירת חשבון שירות

יצירת מפתח באופן ידני

אם הממשק שלמעלה לא עובד, אפשר לנסות את הפעולות הבאות:

1. נכנסים אל מסוף Google Cloud.
2. בוחרים את הפרויקט שדרכו תתבצע הגישה ל-API.
3. בתפריט IAM & admin (ניהול זהויות והרשאות גישה) בצד ימין, מוצאים את האפשרות Service accounts (חשבונות שירות) ויוצרים חשבון שירות חדש שיהיה הבעלים של הפרויקט.
4. אחרי שיוצרים את חשבון השירות, מקבלים מפתח פרטי.

הוספת חשבון שירות לרשימת ההיתרים

אחרי שיוצרים חשבון שירות:

1. פונים לצוות GTAF בכתובת [e-mail] באמצעות חשבון Google שהוא הבעלים של הפרויקט. נוסיף את חשבון Google לרשימת ההיתרים כדי לאפשר גישה לנקודות הקצה של Mobile Data Plan Sharing API.
2. משייכים חשבון שירות לספק בפורטל Google ISP. הספק יכול ליצור את השיוך הזה דרך API Access.

הפעלת הספרייה

אחרי שמוסיפים את האתר לרשימת ההיתרים:

1. נכנסים אל מסוף Google Cloud.
2. מוודאים שבחרתם את הפרויקט הנכון בתפריט הנפתח בסרגל התפריטים העליון.
3. מפעילים את Mobile Data Plan Sharing API ב-API Library.
4. מפעילים את Preprod Mobile Data Plan Sharing API בAPI Library.

בדיקת הגישה ל-API

כדי לבדוק את הגישה לשיטות בצד Google:

1. מתקינים את oauth2l.

2. כך מקבלים אסימון גישה לחשבון השירות: ‫your-service-account-key-file.json הוא קובץ מפתח של חשבון השירות שלכם.

   > oauth2l fetch --json your-service-account-key-file.json dataplansharing
   

   חשוב לדעת: תוקף האסימון לגישה יפוג תוך שעה בערך. לפני שמריצים שוב את הפקודה שלמעלה כדי לקבל אסימון גישה חדש, מריצים את הפקודה oauth2l reset כדי לנקות את המטמון המקומי.

3. כדי לבצע שיחות בדיקה, פועלים לפי השלבים הבאים. ‫YOUR-ASN חייב להיות אחד ממספרי ה-ASN ששלחתם לנו כשהגדרנו את GTAF במהלך תהליך השילוב. ‫ACCESS-TOKEN-OBTAINED הוא הפלט של הפקודה oauth2l fetch שלמעלה. ‫PLAN_STATUS הוא PlanStatus גוף הבקשה שרוצים לשלוח ל-GTAF.

   > url_domain="mobiledataplansharing.googleapis.com"
   > url_path="v1/operators/YOUR-ASN/clients/mobiledataplan/users/USER_KEY/planStatus"
   > curl -H "Content-Type: application/json" \
          -d 'PLAN_STATUS' \
          -X POST "https://$url_domain/$url_path?access_token=ACCESS-TOKEN-OBTAINED"
   

קריאות ל-API באופן פרוגרמטי

פועלים לפי ההוראות כדי לבצע שיחות מאושרות לשיטות בצד של Google, עם היקף OAuth הבא:

https://www.googleapis.com/auth/dataplansharing

שיתוף הבעלות על הפרויקט

למרות שההגדרה הראשונית כוללת חשבון Google אחד, מומלץ להגדיר קבוצה של משתמשים מורשים כבעלים של הפרויקט. בGoogle Cloud Console, בתפריט IAM & admin, אפשר להוסיף חברים חדשים (כולל חשבון של קבוצת Google) שיהיו בעלי הפרויקט.