במדריכים למתחילים מוסבר איך להגדיר ולהפעיל אפליקציה שקוראת ל-Google Workspace API.
המדריכים למתחילים של Google Workspace משתמשים בספריות הלקוח של ה-API כדי לטפל בפרטים מסוימים בתהליך האימות וההרשאה. מומלץ להשתמש בספריות הלקוח לאפליקציות שלכם. המדריך למתחילים הזה משתמש בגישת אימות פשוטה שמתאימה לסביבת בדיקה. בסביבת ייצור מומלץ ללמוד על אימות והרשאה לפני בחירת פרטי הכניסה שמתאימים לאפליקציה.
יוצרים אפליקציית אינטרנט של JavaScript ששולחת בקשות ל-API של יומן Google.
מטרות
- מגדירים את הסביבה.
- הגדרת הדוגמה.
- מריצים את הדוגמה.
דרישות מוקדמות
- Node.js ו-npm הותקנו.
- פרויקט ב-Google Cloud:
- חשבון Google שיומן Google מופעל בו.
הגדרת הסביבה
כדי להשלים את המדריך למתחילים הזה, עליכם להגדיר את הסביבה.
הפעלת ה-API
לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.במסוף Google Cloud, מפעילים את ממשק ה-API של יומן Google.
הגדרת מסך ההסכמה של OAuth
אם אתם משתמשים בפרויקט חדש ב-Google Cloud כדי להשלים את המדריך למתחילים הזה, תצטרכו להגדיר את מסך ההסכמה ל-OAuth ולהוסיף את עצמכם כמשתמשי בדיקה. אם כבר השלמתם את השלב הזה בפרויקט ב-Cloud, דלגו לקטע הבא.
- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > מסך ההסכמה של OAuth.
- בקטע סוג המשתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.
- ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.
בשלב הזה אפשר לדלג על הוספת היקפי הרשאות וללחוץ על שמירה והמשך. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, תצטרכו לשנות את סוג המשתמש לחיצוני ואז להוסיף את היקפי ההרשאות שנדרשים לאפליקציה שלכם.
- מעיינים בסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם נראה שרישום האפליקציה תקין, לוחצים על Back to Dashboard.
אישור פרטי כניסה לאפליקציית אינטרנט
כדי לאמת משתמשי קצה ולגשת לנתוני משתמשים באפליקציה, צריך ליצור מזהה לקוח אחד או יותר ב-OAuth 2.0. מזהה לקוח משמש לזיהוי של אפליקציה יחידה בשרתי ה-OAuth של Google. אם האפליקציה פועלת בכמה פלטפורמות, צריך ליצור מזהה לקוח נפרד לכל פלטפורמה.- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
- לוחצים על Create Credentials > OAuth client ID.
- לוחצים על Application type (סוג אפליקציה) > Web application.
- בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
- מוסיפים מזהי URI מורשים שקשורים לאפליקציה:
- אפליקציות בצד הלקוח (JavaScript) – בקטע מקורות JavaScript מורשים, לוחצים על הוספת URI. לאחר מכן, מזינים URI שישמש לבקשות דפדפן. הנתון הזה מזהה את הדומיינים שמהם האפליקציה יכולה לשלוח בקשות API לשרת OAuth 2.0.
- אפליקציות בצד השרת (Java, Python ועוד) – בקטע מזהי URI מורשים להפניה אוטומטית, לוחצים על הוספת URI. לאחר מכן, מזינים URI של נקודת קצה שאליה שרת OAuth 2.0 יכול לשלוח תשובות.
- לוחצים על יצירה. יופיע המסך שנוצר על ידי לקוח OAuth ומוצג בו מזהה הלקוח החדש וסוד הלקוח שלכם.
שימו לב למזהה הלקוח. באפליקציות אינטרנט אי אפשר להשתמש בסודות של לקוחות.
- לוחצים על אישור. פרטי הכניסה החדשים שנוצרו יופיעו בקטע מזהי לקוחות OAuth 2.0.
מומלץ לרשום את פרטי הכניסה האלה, כי תצטרכו אותם בהמשך במדריך למתחילים.
יצירה של מפתח API
- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
- לוחצים על Create credentials > API key.
- מפתח ה-API החדש מוצג.
- צריך ללחוץ על 'העתקה' כדי להעתיק את מפתח ה-API לשימוש בקוד האפליקציה. תוכלו למצוא את מפתח ה-API גם בקטע API Keys (מפתחות API) בפרטי הכניסה של הפרויקט.
- לוחצים על Restrict key כדי לעדכן את ההגדרות המתקדמות ולהגביל את השימוש במפתח ה-API. מידע נוסף זמין במאמר החלת הגבלות על מפתחות API.
הגדרת הדוגמה
- בספריית העבודה, יוצרים קובץ בשם
index.html
. בקובץ
index.html
, מדביקים את הקוד לדוגמה הבא:מחליפים את מה שכתוב בשדות הבאים:
YOUR_CLIENT_ID
: מזהה הלקוח שיצרתם כשהגדרתם את פרטי הכניסה לאפליקציית אינטרנט.YOUR_API_KEY
: מפתח ה-API שיצרתם כדרישה מוקדמת.
הרצת הדוגמה
בספריית העבודה, מתקינים את חבילת ה-http-server:
npm install http-server
בספריית העבודה, מפעילים שרת אינטרנט:
npx http-server -p 8000
- בדפדפן, עוברים אל
http://localhost:8000
. -
תופיע בקשה להרשאת גישה:
- אם עדיין לא נכנסתם לחשבון Google, נכנסים אליו כשמוצגת בקשה לעשות זאת. אם נכנסת לכמה חשבונות, צריך לבחור חשבון אחד שישמש להרשאה.
- לוחצים על אישור.
אפליקציית JavaScript מפעילה את ממשק ה-API של יומן Google וקוראת לו.
השלבים הבאים
- יצירת אירועים
- פתרון בעיות באימות ובהרשאה
- מאמרי העזרה של Calendar API
- הקטע
google-api-javascript-client
ב-GitHub