Memanggil API

Memanggil API

Format permintaan

Sebagian besar operasi Verifikasi Situs yang didukung dipetakan langsung ke kata kerja HTTP REST (GET, POST, PUT, DELETE), seperti yang dijelaskan dalam operasi Google Site Verification API.

Format khusus untuk URI Google Site Verification API adalah:

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

dengan resourceID adalah ID untuk resource web, parameters adalah parameter apa pun yang akan diterapkan pada kueri. Parameter sebenarnya yang Anda gunakan bervariasi bergantung pada operasi yang Anda jalankan. Selain itu, jika menggunakan OAuth 2.0, Anda harus menetapkan access_token dalam parameter ini.

Kueri daftar tidak memerlukan resourceID, sehingga formatnya adalah:

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

Anda dapat melakukan panggilan ke operasi getToken dengan URI uniknya sendiri. Format panggilan ke getToken adalah:

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

Format data

Google Site Verification API menampilkan data dalam format JSON.

JSON (JavaScript Object Notation) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk informasi selengkapnya, lihat json.org.

Ringkasan operasi

Anda dapat memanggil enam metode berbeda pada koleksi dan resource di Google Site Verification API, seperti yang dijelaskan dalam tabel berikut. URL API bersifat relatif terhadap https://www.googleapis.com/siteVerification/v1.

Contoh panggilan API

Bagian ini mengasumsikan bahwa Anda (developer) juga merupakan pengguna terautentikasi, seperti yang akan terjadi saat Anda pertama kali mencoba API dengan data pengujian Anda sendiri.

Verifikasi situs baru

Untuk memverifikasi situs,

1. Pertama-tama, minta token verifikasi dengan memanggil getToken.
2. Tempatkan token di situs Anda menggunakan metode apa pun yang Anda pilih.
3. Minta Google untuk memverifikasi bahwa situs tersebut milik Anda, menggunakan operasi insert.

getToken (membutuhkan otorisasi)

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

Permintaan:

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

Respons:

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

Masukkan (memerlukan otorisasi)

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

Permintaan:

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

Respons:

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

Mengambil informasi untuk resource web terverifikasi

Anda dapat mengambil daftar lengkap situs dan domain terverifikasi dengan memanggil list. Anda dapat mengambil informasi untuk satu referensi web dengan memanggil get.

Daftar (memerlukan otorisasi)

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

Permintaan:

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

Respons:

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

Dapatkan (memerlukan otorisasi)

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

Permintaan:

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

Respons:

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

Mengubah informasi verifikasi

Anda dapat mendelegasikan dan mencabut kepemilikan dengan memanggil update. Anda dapat menghapus kepemilikan untuk diri sendiri dengan memanggil delete.

Update (memerlukan otorisasi)

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

Permintaan:

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

Respons:

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

Hapus (memerlukan otorisasi)

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

Permintaan:

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

Respons:

Kode status HTTP 204 (Tidak Ada Konten), yang menunjukkan keberhasilan.