כדי להמשיך, חשוב לוודא שהשלמת את השלבים בקטע דרישות מוקדמות ושאישרנו את הגישה של הפרויקט לממשקי API של'פרופיל העסק ב-Google'.
הפעלת ממשקי ה-API
יש שמונה ממשקי API שמשויכים לפרופיל העסק וצריך להפעיל אותם במסוף Google API:
- Google My Business API
- ממשק ה-API לניהול חשבון העסק שלי
- My Business Lodging API
- ממשק ה-API של 'פעולות במקום של העסק שלי'
- My Business Notifications API
- ממשק ה-API לאימות העסק שלי
- ממשק ה-API של פרטי העסק שלי
- ממשק API של שאלות ותשובות לעסק שלי
הפעלת API
אם השלמתם את כל הדרישות המוקדמות וקיבלתם גישה ל-API, אבל אתם עדיין לא מצליחים להשתמש בקיצור הדרך הזה, תוכלו להפעיל את ה-API באופן ידני באמצעות השלבים הבאים.
כדי להפעיל API לפרויקט:
- פותחים את ספריית ה-API במסוף Google API. אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש. בספריית ה-API מפורטים כל ממשקי ה-API הזמינים, בקיבוץ לפי משפחת המוצרים והפופולריות.
- אם ממשק ה-API שרוצים להפעיל לא מופיע ברשימה, אפשר להשתמש בחיפוש כדי למצוא אותו.
- בוחרים את ה-API שרוצים להפעיל ולוחצים על הלחצן Enable.
- אם מופיעה בקשה, מפעילים את החיוב.
- אם מופיעה בקשה, מאשרים את התנאים וההגבלות של ה-API.
אם אתם משתמשים ב-Google Workspace, עליכם לוודא שפרופיל העסק ב-Google מופעל בחשבון שלכם בארגון שלכם ב-Google Workspace. אם פרופיל העסק ב-Google מושבת בחשבון שלך בארגון ב-Google Workspace, ההודעה 'שגיאה 403 – הרשאה DENIED' תוצג כשמשתמשים בממשקי ה-API של GBP.
בקשת מזהה לקוח ב-OAuth 2.0
מכיוון שהאפליקציה שלך ניגשת לנתונים מוגנים שאינם ציבוריים, נדרש מזהה לקוח מסוג OAuth 2.0. הפעולה הזו מאפשרת לאפליקציה לבקש הרשאה לגשת לנתוני המיקום של הארגון בשם משתמשי האפליקציה.
האפליקציה צריכה לשלוח אסימון OAuth 2.0 עם כל בקשה של ממשקי Business Profile API שניגשת לנתוני משתמשים פרטיים.
אם עדיין לא עשיתם זאת, נכנסים לקטע Credentials במסוף Google API ולוחצים על Create credentials > מזהה לקוח ב-OAuth כדי ליצור את פרטי הכניסה ל-OAuth 2.0. אחרי שיוצרים את פרטי הכניסה, אפשר לראות את מזהה הלקוח בדף Credentials. לוחצים על מזהה הלקוח כדי לראות פרטים, כמו סוד לקוח, מזהי URI להפניה אוטומטית, כתובת מקורות של JavaScript וכתובת אימייל.
העקרונות הבסיסיים של REST
יש שתי דרכים להפעיל את ממשקי ה-API:
- שולחים בקשת HTTP ומנתחים את התשובות.
- משתמשים בספריות לקוח.
אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להבין את העקרונות הבסיסיים של REST.
REST הוא סגנון של ארכיטקטורת תוכנה שמאפשר גישה נוחה ועקבית לשליחת בקשות ולשינוי של נתונים.
המונח REST הוא קיצור של Representational State Transfer. בהקשר של Google APIs, REST מתייחס לשימוש בפעלים של HTTP כדי לאחזר ולשנות ייצוגים של נתונים ש-Google מאחסנת.
מערכת RESTful מאחסנת משאבים במאגר נתונים. לקוח שולח בקשה לשרת לבצע פעולה מסוימת, כמו יצירה, אחזור, עדכון או מחיקה של משאב, והשרת מבצע את הפעולה ושולח תגובה. בדרך כלל התגובה הזו היא ייצוג של המשאב שצוין.
בממשקי RESTful API של Google, הלקוח מציין פעולה עם פועל של HTTP, כמו GET, POST, PUT או DELETE. הלקוח מציין משאב באמצעות מזהה משאב אחיד (URI) ייחודי גלובלי (URI) בפורמט הבא:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
מכיוון שלכל משאבי ה-API יש מזהה URI ייחודי שאפשר לגשת אליו באמצעות HTTP, ב-REST אפשר לשמור נתונים במטמון והוא מותאם לעבודה עם התשתית המבוזרת של האינטרנט.
תוכלו להיעזר בהגדרות ה-method במשאבי העזרה של תקני HTTP 1.1. הם כוללים מפרטים של GET, POST, PUT וגם
DELETE.
REST בממשקי ה-API של פרופיל העסק ב-Google
הפעולות של ממשקי ה-API של פרופיל העסק ב-Google ממופות ישירות לפעלים מסוג REST HTTP.
הפורמט הספציפי של ממשקי Business Profile API מוצג ב-URI הבא:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
הקבוצה המלאה של מזהי URI שמשמשים לכל פעולה נתמכת בממשקי ה-API מופיעה בחומרי העזר של ממשקי ה-API של פרופיל העסק.
נתיבי המשאבים משתנים בהתאם לנקודת הקצה.
למשל, נתיב המשאב לחשבון מופיע בדוגמה הבאה:
accounts/accountId
נתיב המשאב של מיקום מופיע בצורה הבאה:
locations/locationId
העקרונות הבסיסיים של JSON
ממשקי ה-API של 'פרופיל העסק ב-Google' מחזירים נתונים בפורמט JSON.
JavaScript Object Notation (JSON) הוא פורמט נתונים נפוץ ובלתי תלוי בשפה, שבו מבני נתונים שרירותיים מיוצגים באמצעות טקסט פשוט. למידע נוסף, ראו json.org.
שימוש ב-OAuth Playground כדי לשלוח בקשת HTTP פשוטה
תוכלו להשתמש ב-OAuth 2.0 Playground כדי להתנסות בממשקי ה-API של פרופיל העסק. מכיוון שממשקי ה-API של 'פרופיל העסק ב-Google' הם לא ממשקי API ציבוריים, יש כמה פעולות נוספות שצריך לבצע כדי להשתמש בהם ב-Playground. כדי להמשיך, אתם צריכים מזהה לקוח.
- נכנסים אל Google API Console ופותחים את הפרויקט. אם אין לך מזהה לקוח OAuth לאפליקציות אינטרנט, עליך ליצור מזהה עכשיו:
- ברשימה הנפתחת Create credentials, בוחרים באפשרות OAuth client ID.
- בקטע Application type לוחצים על Web Application.
צריך להוסיף את הקטע הבא כ-URI תקין להפניה אוטומטית:
https://developers.google.com/oauthplayground
- לוחצים על יצירה.
- מעתיקים את מזהה הלקוח ללוח.
- נכנסים אל OAuth 2.0 Playground.
- לוחצים על סמל גלגל השיניים כדי לפתוח את אפשרויות התצורה ולבצע את השינויים הבאים:
- מגדירים את תהליך OAuth לבצד הלקוח.
- בוחרים באפשרות שימוש בפרטי הכניסה שלך ב-OAuth.
- מדביקים את מזהה הלקוח ב-OAuth.
- סוגרים את אפשרויות ההגדרה.
בקטע 'שלב 1 – בחירה ואישור של ממשקי API', מדביקים את ההיקף הבא של ממשקי ה-API של פרופיל העסק בשדה הזנת היקפים משלכם:
https://www.googleapis.com/auth/business.manage
- לוחצים על Authorize APIs.
- כשמופיעה בקשה, לוחצים על אישור.
-
בקטע Step 2 - Configuration request to API, מדביקים את ה-URI הבא בשדה Request URI:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- לוחצים על שליחת הבקשה. הסטטוס של התגובה צריך להיות
200 OK.
מידע נוסף על שליחת סוגים שונים של בקשות זמין בחומר העזר בנושא ממשקי API של פרופיל העסק ב-Google.
ספריות לקוח
ספריות הלקוח של ממשקי ה-API של 'פרופיל העסק ב-Google' תומכות בפונקציונליות של ממשקי ה-API של 'פרופיל העסק ב-Google'. הם מספקים פונקציונליות משותפת לכל ממשקי ה-API של Google, כמו העברת HTTP, טיפול בשגיאות, אימות וניתוח JSON.
כדי להוריד ספריות לקוח, ראו ספריות.