דרישות האימות של Search Console API
כל בקשה שהאפליקציה שולחת ל-Google Search Console API חייבת לכלול אסימון הרשאה. אסימון ההרשאה גם מזהה את האפליקציה שלכם ב-Google.
הסבר על פרוטוקולים של הרשאות
כדי לאשר בקשות, האפליקציה חייבת להשתמש בפרוטוקול OAuth 2.0. אין תמיכה בפרוטוקולים אחרים של הרשאות. אם האפליקציה משתמשת בכניסה באמצעות חשבון Google, היבטים מסוימים של ההרשאות מטופלים באופן אוטומטי.
הרשאת בקשות עם פרוטוקול OAuth 2.0
כל הבקשות ל-Google Search Console API חייבות להיות מאושרות על ידי משתמש מאומת.
הפרטים או ה"זרימה" של תהליך ההרשאה עם OAuth 2.0 עשויים להשתנות מעט, בהתאם לסוג האפליקציה שאתם מפתחים. התהליך הכללי הבא חל על כל סוגי האפליקציות:
- כשאתם מפתחים את האפליקציה, צריך לרשום אותה באמצעות Google API Console. לאחר הרישום, Google מספקת נתונים שיהיו דרושים לכם מאוחר יותר, כמו מזהה לקוח וסוד לקוח.
- מפעילים את Google Search Console API ב-Google API Console. (אם ממשק ה-API לא מופיע במסוף ה-API, אפשר לדלג על השלב הזה.)
- כשהאפליקציה צריכה גישה לנתונים של משתמשים, היא מעבירה ל-Google בקשת גישה בהיקף ספציפי.
- Google מציגה למשתמש מסך הסכמה ומבקשת לאשר לאפליקציה לשלוח בקשה לחלק מהנתונים שלו.
- אם המשתמש מסכים, האפליקציה מקבלת מ-Google אסימון גישה לטווח קצר.
- האפליקציה מבקשת את נתוני המשתמש ומצרפת לבקשה את אסימון הגישה.
- אם Google תקבע שהבקשה והאסימון תקפים, היא תחזיר את הנתונים המבוקשים.
חלק מתהליכי העבודה כוללים שלבים נוספים, כמו שימוש באסימוני רענון כדי לקבל אסימוני גישה חדשים. למידע מפורט על תהליכי העבודה לסוגים שונים של אפליקציות, ניתן לעיין בתיעוד של OAuth 2.0 של Google.
הפרטים לגבי היקפי OAuth 2.0 ב-Google Search Console API:
| היקף | משמעות |
|---|---|
https://www.googleapis.com/auth/webmasters |
גישת קריאה/כתיבה. |
https://www.googleapis.com/auth/webmasters.readonly |
הרשאת קריאה בלבד. |
כדי לבקש גישה באמצעות פרוטוקול OAuth 2.0, האפליקציה שלכם זקוקה למידע על ההיקף ולמידע ש-Google מספקת בזמן רישום האפליקציה (כמו מזהה לקוח וסוד לקוח).
טיפ: ספריות הלקוח של Google APIs יכולות לטפל עבורכם בחלק מתהליך ההרשאה. הן זמינות למגוון שפות תכנות. לפרטים נוספים, עיינו בדף עם ספריות ודוגמאות.
דרישות לאימות ה-API של כלי הבדיקה של Search Console
רכישה של מפתח API ושימוש בו
בקשות לממשק ה-API של כלי הבדיקה של Search Console עבור נתונים ציבוריים חייבות להיות מלוות במזהה, שיכול להיות מפתח API או אסימון גישה.
כדי לרכוש מפתח API:
- פותחים את דף פרטי הכניסה ב-API Console.
-
ממשק ה-API הזה תומך בשני סוגים של פרטי כניסה.
יוצרים את פרטי הכניסה המתאימים לפרויקט:
-
OAuth 2.0: בכל פעם שהאפליקציה שלך מבקשת נתוני משתמש פרטיים, עליה לשלוח אסימון OAuth 2.0 בנוסף לבקשה. קודם כל, האפליקציה שולחת מזהה לקוח, וגם סוד לקוח כדי לקבל אסימון. אפשר ליצור פרטי כניסה בפרוטוקול OAuth 2.0 לאפליקציות אינטרנט, לחשבונות שירות או לאפליקציות מותקנות.
למידע נוסף, עיינו בתיעוד של OAuth 2.0.
-
מפתחות API: בקשה שלא מספקת אסימון OAuth 2.0 חייבת לשלוח מפתח API. המפתח מזהה את הפרויקט ומספק גישה ל-API, מכסה ודוחות.
ממשק ה-API תומך במספר סוגים של הגבלות על מפתחות API. אם מפתח ה-API שנחוץ לא קיים, יש ליצור מפתח API במסוף. לשם כך לוחצים על יצירת פרטי כניסה > מפתח ה-API. אפשר להגביל את המפתח לפני שמשתמשים בו בסביבת הייצור בלחיצה על Restrict key ואז על אחת מההגבלות.
-
כדי להגן על מפתחות ה-API, כדאי לפעול לפי השיטות המומלצות לשימוש מאובטח במפתחות API.
אחרי שמקבלים מפתח API, האפליקציה יכולה לצרף את פרמטר השאילתה key=yourAPIKey לכל כתובות ה-URL של הבקשות.
מפתח ה-API בטוח להטמעה בכתובות URL, ללא צורך בקידוד.