בקטע 'פרטי כניסה' בכלי APIs Explorer אפשר לבדוק עם פרטי כניסה והיקפים שונים. התכונה הזו שימושית כדי לוודא שאתם משתמשים בפרטי הכניסה ובהיקף ההרשאות המינימליים שנדרשים להפעלת נקודת קצה של API.
בדיקה עם פרטי כניסה שונים
כברירת מחדל, המערכת בודקת את סוגי פרטי הכניסה OAuth 2 ומפתח API. אם רוצים לבדוק רק עם פרטי כניסה אחדים, מסמנים את סוג פרטי הכניסה שרוצים להשתמש בו (ומבטלים את הסימון של סוג פרטי הכניסה האחר). אלה הכללים הכלליים לבחירת פרטי כניסה לבדיקה:
אם אתם משתמשים בשיטה לגישה לנתונים ציבוריים, כמו נתונים של מפות Google, אתם יכולים להשתמש במפתח API כפרטי הכניסה שלכם. מסמנים את האפשרות API key ומבטלים את הסימון של Google OAuth 2.0.
אם אתם משתמשים בשיטה לגישה לנתונים פרטיים, כמו נתונים ב-Google Drive של המשתמש, אתם צריכים להשתמש באמצעי אימות OAuth 2. מבטלים את הסימון של API key ומסמנים את Google OAuth 2.0.
אם מקבלים תוצאה של 200, פרטי הכניסה מספיקים כדי לגשת לנתונים. אם מקבלים תוצאה של 401, צריך להשתמש בפרטי כניסה של OAuth 2 כדי לגשת לנתונים.
בדיקה עם היקפים שונים
היקף הוא מחרוזת, כמו https://www.googleapis.com/auth/drive.metadata.readonly, שמגדירה רמת גישה למשאבים שנדרשים לאפליקציה, כמו רמת הגישה לנתונים שבבעלות המשתמשים. מומלץ שהאפליקציה תשתמש בהיקפי הרשאות עם רמת הגישה המצומצמת ביותר לנתוני המשתמש. יכול להיות ששיטות שונות ידרשו היקפים שונים. לדוגמה, יכול להיות ש-method מסוים ב-API ידרוש לפחות היקף הרשאות לקריאה בלבד, בעוד ש-method אחר ידרוש היקף הרשאות לקריאה ולכתיבה.
כברירת מחדל, כל היקפי ההרשאות של Google OAuth 2.0 עבור API מופעלים ב-APIs Explorer. כדי לבצע בדיקה בהיקף ספציפי:
- בקטע Credentials Google OAuth 2.0 (פרטי כניסה Google OAuth 2.0), לוחצים על show scopes (הצגת היקפי הרשאות).
- בודקים את היקף ההרשאה שצריך להשתמש בו כשמפעילים את השיטה.
- לוחצים על Execute כדי להפעיל את ה-API רק עם ההיקף שנבחר. ב-APIs Explorer מוצג מסך הרשאה שבו מתבקשת הרשאת גישה לשימוש בהיקף.
- לוחצים על אישור. התוצאות מופיעות מתחת ללחצן Execute (הפעלה).
אם ב-APIs Explorer מופיעה תוצאה של 200 בקטע application/json, סימן שההיקף מספיק להפעלת ה-method. אם ב-APIs Explorer מוצגת תוצאה של 403, סימן שבחרתם בהיקף לא מספיק להפעלת השיטה. כדאי לנסות היקף רחב יותר.
מידע נוסף על בחירת היקף ההרשאות מופיע בקטע בנושא אימות והרשאה במסמכי התיעוד של ממשק Google API הספציפי.
ביטול גישה מורשית כדי לבצע בדיקה עם היקפי הרשאות חדשים
אחרי שמשתמשים במסך ההרשאות של Google כדי לאשר הרשאה, ל-APIs Explorer יש הרשאה לשלוח בקשות מאומתות כל עוד תוקף פרטי הכניסה לא פג. ביטול הסימון של היקפי ההרשאות לא מאפס את פרטי הכניסה והיקפי ההרשאות שאושרו בעבר. אם רוצים לבדוק עם הגדרת היקף חדשה, צריך לבטל את האישורים שאושרו קודם.
כדי לבטל את פרטי הכניסה שמשמשים את הכלי APIs Explorer:
- עוברים אל אפליקציות שיש להן גישה לחשבון.
- בקטע אפליקציות של צד שלישי עם גישה לחשבון, לוחצים על Google APIs Explorer.
- לוחצים על הסרת הגישה.
- (אופציונלי) טוענים מחדש את דף התיעוד כדי לאפס את APIs Explorer.