במדריכים למתחילים מוסבר איך להגדיר ולהפעיל אפליקציה שקוראת ל-Google Workspace API.
כדי לטפל בפרטים מסוימים בתהליך האימות וההרשאה, המדריכים למתחילים של Google Workspace משתמשים בספריות לקוח ה-API. אנחנו ממליצים להשתמש בספריות הלקוח של האפליקציות שלכם. המדריך למתחילים משתמש בגישת אימות פשוטה שמתאימה לסביבת הבדיקה. בסביבת ייצור, מומלץ ללמוד על אימות והרשאה לפני לבחור את פרטי הכניסה שמתאימים לאפליקציה.
יוצרים אפליקציית שורת פקודה של Go ששולחת בקשות ל-Admin SDK API.
מטרות
- הגדרת הסביבה.
- מגדירים את הדוגמה.
- מריצים את הדוגמה.
דרישות מוקדמות
- את הגרסה האחרונה של Go.
- את הגרסה האחרונה של Git.
- פרויקט ב-Google Cloud.
- דומיין ב-Google Workspace שמופעלת בו גישה ל-API.
- חשבון Google בדומיין הזה עם הרשאות מנהל.
הגדרת הסביבה
כדי להשלים את המדריך למתחילים, צריך להגדיר את הסביבה.
מפעילים את ה-API
כדי להשתמש ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.במסוף Google Cloud, מפעילים את Admin SDK API.
הגדרת מסך ההסכמה של OAuth
אם אתם משתמשים בפרויקט חדש ב-Google Cloud כדי להשלים את המדריך למתחילים, צריך להגדיר את מסך ההסכמה של OAuth ולהוסיף את עצמכם כמשתמשי בדיקה. אם כבר השלמתם את השלב הזה בפרויקט Cloud, דלגו לקטע הבא.
- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > מסך ההסכמה של OAuth.
- בוחרים את סוג המשתמש לאפליקציה ולוחצים על יצירה.
- ממלאים את טופס ההרשמה לאפליקציה ולוחצים על שמירה והמשך.
בינתיים, אפשר לדלג על הוספת היקפים וללחוץ על שמירה והמשך. בעתיד, כשתיצור אפליקציה לשימוש מחוץ לארגון שלך ב-Google Workspace, יהיה עליך להוסיף ולאמת את היקפי ההרשאות שנדרשים לאפליקציה.
- אם בחרתם בסוג המשתמש חיצוני, מוסיפים משתמשי בדיקה:
- בקטע משתמשים לבדיקה, לוחצים על הוספת משתמשים.
- מזינים את כתובת האימייל שלכם ואת שאר המשתמשים המורשים לבדיקה, ואז לוחצים על Save and Continue (שמירה והמשך).
- לבדוק את הסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרישום של האפליקציה נראה בסדר, לוחצים על Back to Dashboard (חזרה למרכז השליטה).
אישור פרטי כניסה לאפליקציה בשולחן העבודה
כדי לאמת משתמשי קצה ולגשת לנתוני המשתמשים באפליקציה, צריך ליצור מזהה לקוח אחד או יותר של OAuth 2.0. מזהה הלקוח משמש לזיהוי אפליקציה יחידה לשרתי OAuth של Google. אם האפליקציה פועלת בכמה פלטפורמות, צריך ליצור מזהה לקוח נפרד לכל פלטפורמה.- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
- לוחצים על יצירת פרטי כניסה > מזהה לקוח OAuth.
- לוחצים על סוג האפליקציה > אפליקציה למחשב.
- בשדה שם, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
- לוחצים על Create. מופיע המסך של לקוח OAuth שנוצר, ומוצגים בו מזהה הלקוח וסוד הלקוח החדשים.
- לוחצים על אישור. פרטי הכניסה החדשים שנוצרו מופיעים בקטע מזהי לקוח ב-OAuth 2.0.
- שומרים את קובץ ה-JSON שהורדתם בתור
credentials.json
ומעבירים אותו לספריית העבודה.
הכנת סביבת העבודה
יצירה של ספריית עבודה:
mkdir quickstart
מעבר לספריית העבודה:
cd quickstart
מפעילים את המודול החדש:
go mod init quickstart
קבלו את ספריית הלקוח של Admin SDK API Go ואת חבילת OAuth2.0:
go get google.golang.org/api/admin/reports/v1 go get golang.org/x/oauth2/google
הגדרת הדוגמה
בספריית העבודה, יוצרים קובץ בשם
quickstart.go
.מדביקים את הקוד הבא בקובץ:
הרצת הדוגמה
בספריית העבודה, יוצרים ומריצים את הדוגמה:
go run quickstart.go
-
בפעם הראשונה שמריצים את הדוגמה, מוצגת בקשה להעניק הרשאת גישה:
- אם עדיין לא נכנסתם לחשבון Google, נכנסים כשמוצגת בקשה לעשות זאת. אם נכנסת לכמה חשבונות, צריך לבחור חשבון אחד שישמש לצורך הרשאה.
- לוחצים על אישור.
אפליקציית Go מפעילה את ה-Admin SDK API וקוראת לו.
פרטי ההרשאות מאוחסנים במערכת הקבצים, כך שבפעם הבאה שמריצים את הקוד לדוגמה לא תוצג בקשה להרשאה.
השלבים הבאים
- פתרון בעיות שקשורות לאימות ולהרשאות
- חומרי עזר ל-Admin SDK Reports API
- קטע
google-api-go-client
ב-GitHub