Tài liệu này mô tả cách sử dụng API xác minh trang web của Google.
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ợ sẽ ánh xạ trực tiếp đến động từ HTTP REST (GET, POST, PUT, DELETE), như được mô tả trong thao tác API Xác minh trang web của Google.
Đị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 cho một tài nguyên web, parameters là bất kỳ tham số nào để áp dụng cho truy vấn. Các tham số thực tế bạn sử dụng thay đổi tùy theo hoạt động 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.
Các 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 theo URI duy nhất của riêng nó. Định dạng của lệnh gọi getToken là:
https://www.googleapis.com/siteVerification/v1/token?parameters
Định dạng dữ liệu
API xác minh trang web của Google 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, độc lập về 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 về các bộ sưu tập và tài nguyên trong API xác minh trang web của Google, như được mô tả trong bảng sau. URL API tương ứng với https://www.googleapis.com/siteVerification/v1.
| Hoạt động | Mô tả | URL và cú pháp |
|---|---|---|
| list | Liệt kê tất cả tài nguyên trong bộ sưu tập của người dùng đã xác thực. |
|
| chèn | Xác minh trang web hoặc miền. Nếu thành công, hãy chèn tài nguyên web mới vào bộ sưu tập của người dùng. Nội dung yêu cầu: Xem Tài nguyên web. Tham số truy vấn: |
|
| tải | Nhận dữ liệu mới nhất về một tài nguyên web cụ thể. |
|
| cập nhật | Sửa đổi danh sách chủ sở hữu cho một tài nguyên cụ thể. Nội dung yêu cầu: Xem Tài nguyên web. Lưu ý:
|
|
| xóa | Xoá tài nguyên khỏi bộ sưu tập của người dùng (xác minh rằng trang web thuộc về người dùng).
|
Xem ví dụ về yêu cầu xóa. |
| getToken | Lấy mã xác minh để đặt trên trang web đã xác thực của người dùng. Nội dung yêu cầu:
|
Hãy xem ví dụ về yêu cầu getToken. |
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 được xác thực, như trường hợp khi bạn thử API lần đầu bằng dữ liệu thử nghiệm của riêng mình.
Xác minh trang web mới
Để xác minh một trang web,
- Trước tiên, hãy yêu cầu mã xác minh bằng cách gọi getToken.
- Đặt mã thông báo trên trang web của bạn bằng bất kỳ phương thức nào bạn chọn.
- 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 insert.
getToken (yêu cầu ủy 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 ủy 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 tài nguyên web đã xác minh
Bạn có thể truy xuất danh sách đầy đủ các trang web và miền đã xác minh của mình bằng cách gọi danh sách. 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 ủy 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 ủy 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 update. Bạn có thể xóa quyền sở hữu cho chính mình bằng cách gọi delete.
Cập nhật (yêu cầu ủy 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"
}
}
Xóa (yêu cầu ủy 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.