הפעלת ה-API

הפעלת ה-API

פורמט הבקשה

רוב הפעולות הנתמכות של אימות אתר ממופות ישירות לפעלים מסוג REST HTTP (GET, POST, PUT, DELETE), כפי שמתואר בפעולות של Google Site Verification API.

הפורמט הספציפי למזהי URI של Google Site Verification API הם:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

כאשר resourceID הוא המזהה של משאב אינטרנט, parameters הם כל הפרמטרים שצריך להחיל על השאילתה. הפרמטרים שבהם תשתמשו בפועל משתנים בהתאם לפעולה שאתם מבצעים. בנוסף, אם משתמשים ב-OAuth 2.0, צריך להגדיר את access_token בפרמטרים האלה.

בשאילתות של רשימה לא נדרש resourceID, לכן הפורמט הוא:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

אפשר לבצע קריאות לפעולה getToken באמצעות URI ייחודי משלה. הפורמט של קריאה ל-getToken הוא:

https://www.googleapis.com/siteVerification/v1/token?parameters

פורמט נתונים

Google Site Verification API מחזיר נתונים בפורמט JSON.

JSON‏ (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף: json.org.

סיכום הפעולות

תוכלו להפעיל שש שיטות שונות לאוספים ולמשאבים ב-Google Site Verification API, כמו שמתואר בטבלה הבאה. כתובות ה-URL של ה-API הן יחסיות ל-https://www.googleapis.com/siteVerification/v1.

דוגמאות לקריאות ל-API

בקטע הזה יצאנו מנקודת הנחה שאתם (המפתח) גם אתם (המפתח/ת) הם המשתמש המאומת, כמו שקורה כשתנסו בפעם הראשונה את ה-API עם נתוני בדיקה משלכם.

אימות אתר חדש

כדי לאמת אתר,

1. קודם כל מבקשים אסימון אימות באמצעות קריאה ל-getToken.
2. ממקמים את האסימון באתר בכל שיטה שתבחרו.
3. מבקשים מ-Google לאמת שהאתר שייך לכם באמצעות הפעולה insert.

getToken (נדרשת הרשאה)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

בקשה:

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

תשובה:

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

הוספה (נדרשת הרשאה)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

בקשה:

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

תשובה:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

אחזור מידע עבור משאבי אינטרנט מאומתים

ניתן לאחזר את הרשימה המלאה של האתרים והדומיינים המאומתים שלך ב-list. אפשר לאחזר מידע של משאב אינטרנט יחיד על ידי שליחת קריאה ל-get.

רשימה (נדרשת הרשאה)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

בקשה:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

תשובה:

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

קבלה (נדרשת הרשאה)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

בקשה:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

תשובה:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

שינוי של פרטי האימות

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

עדכון (נדרשת הרשאה)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

בקשה:

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

תשובה:

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

מחיקה (נדרשת הרשאה)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

בקשה:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

תשובה:

קוד הסטטוס HTTP 204 (ללא תוכן) שמציין הצלחה.