אישור בקשות

דרישות האימות של Search Console API

כל בקשה שהאפליקציה שולחת אל Google Search Console API חייבת לכלול אסימון הרשאה. אסימון ההרשאה גם מזהה את האפליקציה שלכם ב-Google.

הסבר על פרוטוקולים של הרשאות

כדי לאשר בקשות, האפליקציה חייבת להשתמש בפרוטוקול OAuth 2.0. אין תמיכה בפרוטוקולים אחרים של הרשאות. אם באפליקציה נעשה שימוש בכניסה באמצעות חשבון Google, היבטים מסוימים של ההרשאות מטפלים בשבילכם.

הרשאת בקשות עם פרוטוקול OAuth 2.0

כל הבקשות ל-Google Search Console API חייבות לקבל הרשאה ממשתמש מאומת.

הפרטים או ה"זרימה" של תהליך ההרשאה עם OAuth 2.0 עשויים להשתנות מעט, בהתאם לסוג האפליקציה שאתם מפתחים. התהליך הכללי הבא חל על כל סוגי האפליקציות:

  1. כשיוצרים את האפליקציה, רושמים אותה באמצעות Google API Console. לאחר הרישום, Google מספקת נתונים שיהיו דרושים לכם מאוחר יותר, כמו מזהה לקוח וסוד לקוח.
  2. מפעילים את Google Search Console API ב-Google API Console. (אם ה-API לא מופיע ב-API Console, דלגו על השלב הזה).
  3. כשהאפליקציה צריכה גישה לנתונים של משתמשים, היא מעבירה ל-Google בקשת גישה בהיקף ספציפי.
  4. Google מציגה למשתמש מסך הסכמה ומבקשת לאשר לאפליקציה לשלוח בקשה לחלק מהנתונים שלו.
  5. אם המשתמש מסכים, האפליקציה מקבלת מ-Google אסימון גישה לטווח קצר.
  6. האפליקציה מבקשת את נתוני המשתמש ומצרפת לבקשה את אסימון הגישה.
  7. אם 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 ושימוש בו

בקשות שנשלחות ל-Search Console Testing Tools API עבור נתונים ציבוריים חייבות לכלול מזהה, שיכול להיות מפתח API או אסימון גישה.

כדי לקבל מפתח API:

  1. פותחים את הדף Credentials במסוף ה-API.
  2. ה-API הזה תומך בשני סוגים של פרטי כניסה. בוחרים את פרטי הכניסה שמתאימים לפרויקט:

    • OAuth 2.0: בכל פעם שהאפליקציה שלכם מבקשת נתוני משתמשים פרטיים, היא צריכה לשלוח אסימון OAuth 2.0 יחד עם הבקשה. האפליקציה שולחת קודם מזהה לקוח, אולי גם סוד לקוח, כדי לקבל אסימון. אפשר ליצור פרטי כניסה של OAuth 2.0 לאפליקציות אינטרנט, לחשבונות שירות ולאפליקציות מותקנות.

      מידע נוסף זמין במסמכי התיעוד של OAuth 2.0.

    • מפתחות API: בקשה שלא מספקת אסימון OAuth 2.0 חייבת לשלוח מפתח API. המפתח מזהה את הפרויקט ומספק גישה ל-API, מכסות ודוחות.

      ה-API תומך בכמה סוגים של הגבלות על מפתחות API. אם מפתח ה-API שאתם צריכים עדיין לא קיים, תוכלו ליצור מפתח API במסוף בלחיצה על Create credentials > מפתח API. אפשר להגביל את המפתח לפני שמשתמשים בו בסביבת הייצור, על ידי לחיצה על Restrict key ובחירה באחת מההגבלות.

כדי לשמור על האבטחה של מפתחות ה-API, כדאי לפעול בהתאם לשיטות המומלצות לשימוש מאובטח במפתחות API.

אחרי שיש לכם מפתח API, האפליקציה יכולה לצרף את פרמטר השאילתה key=yourAPIKey לכל כתובות ה-URL של הבקשות.

מפתח ה-API בטוח להטמעה בכתובות URL, אין צורך בקידוד שלו.