Gọi API

Gọi API

Định dạng yêu cầu

Hầu hết các thao tác Xác minh trang web được hỗ trợ đều liên kết trực tiếp đến các động từ HTTP REST (GET, POST, PUT, DELETE), như mô tả trong hoạt động của Google Site Verification API.

Định dạng cụ thể cho URI API Xác minh trang web của Google là:

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

trong đó resourceID là giá trị nhận dạng một tài nguyên trên web, còn parameters là mọi tham số áp dụng cho truy vấn. Các thông số thực tế mà bạn sử dụng sẽ khác nhau tuỳ thuộc vào thao tác mà bạn đang thực hiện. Ngoài ra, nếu đang sử dụng OAuth 2.0, bạn nên đặt access_token trong các tham số này.

Truy vấn danh sách không yêu cầu resourceID, vì vậy định dạng là:

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

Bạn có thể thực hiện lệnh gọi đến thao tác getToken bằng URI duy nhất của riêng lệnh đó. Định dạng của lệnh gọi đến getToken là:

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

Định dạng dữ liệu

API Google Site Verification trả về dữ liệu ở định dạng JSON.

JSON (Ký hiệu đối tượng JavaScript) là một định dạng dữ liệu phổ biến, không phụ thuộc vào ngôn ngữ, cung cấp bản trình bày văn bản đơn giản của các cấu trúc dữ liệu tùy ý. Để biết thêm thông tin, hãy xem json.org.

Tóm tắt hoạt động

Bạn có thể gọi 6 phương thức khác nhau đối với các bộ sưu tập và tài nguyên trong Google Site Verification API, như được mô tả trong bảng sau. Các URL API có liên quan đến https://www.googleapis.com/siteVerification/v1.

Ví dụ về lệnh gọi API

Phần này giả định rằng bạn (nhà phát triển) cũng là người dùng đã xác thực, giống như trong trường hợp bạn dùng thử API lần đầu tiên bằng dữ liệu kiểm thử của riêng mình.

Xác minh một trang web mới

Để xác minh một trang web,

1. Trước tiên, hãy yêu cầu một mã xác minh bằng cách gọi getToken.
2. Đặt mã thông báo trên trang web của bạn bằng bất kỳ phương pháp nào bạn chọn.
3. Yêu cầu Google xác minh rằng trang web là của bạn bằng cách sử dụng thao tác chèn.

getToken (yêu cầu uỷ quyền)

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

Yêu cầu:

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"
  }
}

Phản hồi:

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

Chèn (yêu cầu uỷ quyền)

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

Yêu cầu:

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"
  }
}

Phản hồi:

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

Truy xuất thông tin cho các tài nguyên web đã xác minh

Bạn có thể truy xuất toàn bộ danh sách các trang web và miền đã xác minh bằng cách gọi list. Bạn có thể truy xuất thông tin cho một tài nguyên web bằng cách gọi get.

Danh sách (yêu cầu uỷ quyền)

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

Yêu cầu:

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

Phản hồi:

{
  "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"
      }
    }
  ]
}

Nhận (yêu cầu uỷ quyền)

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

Yêu cầu:

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

Phản hồi:

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

Sửa đổi thông tin xác minh

Bạn có thể uỷ quyền và thu hồi quyền sở hữu bằng cách gọi lệnh update. Bạn có thể tự xoá quyền sở hữu bằng cách gọi lệnh delete.

Cập nhật (yêu cầu uỷ quyền)

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

Yêu cầu:

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"
  }
}

Phản hồi:

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

Xoá (yêu cầu uỷ quyền)

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

Yêu cầu:

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

Phản hồi:

Mã trạng thái HTTP 204 (Không có nội dung), cho biết thành công.