Wywoływanie interfejsu API

Wywoływanie interfejsu API

Format żądania

Większość obsługiwanych operacji weryfikacji witryny jest mapowana bezpośrednio na czasowniki HTTP REST (GET, POST, PUT, DELETE), zgodnie z opisem w operacjach interfejsu Google Site Verification API.

Identyfikatory URI Google Site Verification API mają następujący format:

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

gdzie resourceID to identyfikator zasobu internetowego, a parameters to dowolne parametry stosowane do zapytania. Używane parametry różnią się w zależności od wykonywanej operacji. Poza tym, jeśli korzystasz z protokołu OAuth 2.0, musisz skonfigurować w tych parametrach parametr access_token.

Zapytania wg listy nie wymagają identyfikatora resourceID, więc ich format jest następujący:

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

Możesz wywoływać operację getToken za pomocą własnego unikalnego identyfikatora URI. Format wywołania getToken to:

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

Format danych

Interfejs Google Site Verification API zwraca dane w formacie JSON.

JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który w prosty sposób przedstawia dowolne struktury danych w formie tekstowej. Więcej informacji znajdziesz na stronie json.org.

Podsumowanie operacji

W interfejsie Google Site Verification API możesz wywoływać 6 różnych metod na zbiorach i zasobach, zgodnie z opisem w poniższej tabeli. Adresy URL interfejsu API są względne wobec elementu https://www.googleapis.com/siteVerification/v1.

Przykładowe wywołania interfejsu API

W tej sekcji zakładamy, że Ty (deweloper) jesteś też uwierzytelnionym użytkownikiem, tak jak w przypadku pierwszego wypróbowania interfejsu API z własnymi danymi testowymi.

Zweryfikuj nową witrynę

Aby zweryfikować witrynę,

1. Najpierw poproś o token weryfikacyjny, wywołując metodę getToken.
2. Umieść token w witrynie za pomocą wybranej metody.
3. Poproś Google o zweryfikowanie, czy witryna należy do Ciebie, używając operacji insert.

getToken (wymaga autoryzacji),

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

Prośba:

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

Odpowiedź:

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

Wstaw (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

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

Pobieranie informacji o zweryfikowanych zasobach internetowych

Pełną listę zweryfikowanych witryn i domen możesz pobrać, wywołując list. Aby pobrać informacje dla pojedynczego zasobu internetowego, wywołaj get.

Lista (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

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

Pobierz (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

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

Zmienianie informacji weryfikacyjnych

Prawo własności możesz przekazać i anulować, wywołując update. Możesz usunąć własność dla siebie, wywołując metodę delete.

Aktualizacja (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

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

Usuń (wymaga autoryzacji)

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

Prośba:

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

Odpowiedź:

Kod stanu HTTP 204 (brak treści) wskazujący powodzenie.