Ce document explique comment utiliser l'API Google Site Verification.
Appeler l'API
Format de requête
La plupart des opérations de validation de site compatibles sont mappées directement à des verbes HTTP REST (GET
, POST
, PUT
, DELETE
), comme décrit dans la section Opérations de l'API Google Site Verification.
Le format spécifique des URI de l'API Google Site Verification est le suivant:
https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters
où resourceID
est l'identifiant d'une ressource Web, et parameters
sont les paramètres à appliquer à la requête. Les paramètres que vous utilisez varient en fonction de l'opération que vous effectuez. En outre, si vous utilisez OAuth 2.0, vous devez définir access_token
dans ces paramètres.
Les requêtes de liste ne nécessitent pas de resourceID. Le format est donc le suivant:
https://www.googleapis.com/siteVerification/v1/webResource?parameters
Vous pouvez appeler l'opération getToken par son propre URI unique. Le format d'un appel à getToken est le suivant:
https://www.googleapis.com/siteVerification/v1/token?parameters
Format des données
L'API Google Site Verification renvoie les données au format JSON.
JSON (JavaScript Object Notation) est un format de données qui ne dépend pas d'un langage et qui fournit une représentation textuelle simple de structures de données arbitraires. Pour en savoir plus, accédez à json.org.
Résumé des opérations
Vous pouvez appeler six méthodes différentes sur des collections et des ressources dans l'API Google Site Verification, comme décrit dans le tableau suivant. Les URL d'API sont relatives à https://www.googleapis.com/siteVerification/v1
.
Operations | Description | URL et syntaxe |
---|---|---|
list | Répertorie toutes les ressources de la collection de l'utilisateur authentifié. |
Consultez un exemple de requête list. |
Insérer | Vérifie un site ou un domaine. Si l'opération réussit, elle insère une nouvelle ressource Web dans la collection de l'utilisateur. Corps de la requête: consultez la page Ressource Web. Paramètre de requête: |
Consultez cet exemple de requête insert. |
obtenir | Récupère les données les plus récentes pour une ressource Web spécifique. |
Consultez un exemple de requête get. |
mettre à jour | Modifie la liste des propriétaires pour une ressource spécifique. Corps de la requête: consultez la page Ressource Web. Remarques :
|
Consultez un exemple de requête update. |
supprimer | Supprime une ressource de la collection de l'utilisateur (indique que le site appartient à l'utilisateur).
|
Consultez un exemple de requête delete. |
getToken | Récupère le jeton de validation à placer sur le site Web de l'utilisateur authentifié. Corps de la requête :
|
Consultez cet exemple de requête getToken. |
Exemples d'appels d'API
Dans cette section, nous partons du principe que vous (le développeur) êtes également l'utilisateur authentifié, comme vous le feriez lorsque vous avez essayé l'API pour la première fois avec vos propres données de test.
Valider un nouveau site
Pour valider un site :
- Commencez par demander un jeton de validation en appelant getToken.
- Placez le jeton sur votre site en utilisant la méthode de votre choix.
- Demandez à Google de confirmer que le site vous appartient à l'aide de l'opération insert.
getToken (demande d'autorisation)
POST https://www.googleapis.com/siteVerification/v1/token?access_token=
oauth2-token
Requête :
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"
}
}
Réponse :
{ "token": "google12cfc68677988bb4.html", "method": "FILE" }
Insérer (autorisation requise)
POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=
oauth2-token
Requête :
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"
}
}
Réponse :
{ "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
Récupérer les informations sur les ressources Web validées
Vous pouvez récupérer la liste complète de vos sites et domaines validés en appelant la méthode list. Vous pouvez récupérer les informations d'une seule ressource Web en appelant get.
Liste (autorisation requise)
GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=
oauth2-token
Requête :
GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token
Réponse :
{ "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" } } ] }
Obtenir (autorisation requise)
GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
Requête :
GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Réponse :
{ "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
Modifier les informations de validation
Vous pouvez déléguer et révoquer la propriété en appelant update. Pour supprimer vous-même la propriété, appelez la méthode delete.
Mise à jour (autorisation requise)
PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
Requête :
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"
}
}
Réponse :
{ "owners": [ "myself@example.com", "another@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
Supprimer (autorisation requise)
DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
Requête :
DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Réponse :
Code d'état HTTP 204 (Aucun contenu) indiquant que l'opération a réussi.