En este documento, se describe cómo utilizar la API de verificación de sitios de Google.
Cómo invocar la API
Formato de la solicitud
La mayoría de las operaciones compatibles de Verificación de sitios se asignan directamente a los verbos HTTP de REST (GET
, POST
, PUT
, DELETE
), como se describe en Operaciones de la API de Google Site Verification.
Los formatos específicos para los URI de la API de Google Site Verification son los siguientes:
https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters
donde resourceID
es el identificador de un recurso web, parameters
son cualquier parámetro que se aplique a la consulta. Los parámetros reales que uses varían según la operación que realices. Además, si usas OAuth 2.0, debes configurar access_token
en estos parámetros.
Las consultas de lista no requieren un resourceID, por lo que su formato es el siguiente:
https://www.googleapis.com/siteVerification/v1/webResource?parameters
Puedes realizar llamadas a la operación getToken mediante su propio URI único. El formato de una llamada a getToken es el siguiente:
https://www.googleapis.com/siteVerification/v1/token?parameters
Formato de los datos
La API de Google Site Verification muestra datos en formato JSON.
JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.
Resumen de operaciones
Puedes invocar seis métodos diferentes en las colecciones y los recursos en la API de Google Site Verification, tal como se describe en la siguiente tabla. Las URLs de la API están relacionadas con https://www.googleapis.com/siteVerification/v1
.
Operación | Descripción | URL y sintaxis |
---|---|---|
list | Muestra una lista de todos los recursos incluidos en la colección del usuario autenticado. |
Consulta un ejemplo de solicitud de lista. |
insertar | Verifica un sitio o dominio. Si se aplica de forma correcta, inserta un nuevo recurso web en la colección del usuario. Cuerpo de la solicitud: Consulta Recurso web. Parámetro de consulta: |
Consulta un ejemplo de solicitud de insert. |
get | Obtiene los datos más recientes de un recurso web específico. |
Consulta un ejemplo de solicitud get. |
actualización | Modifica la lista de propietarios de un recurso específico. Cuerpo de la solicitud: Consulta Recurso web. Notas:
|
Consulta un ejemplo de solicitud de actualización. |
borrar | Quita un recurso de la colección del usuario (no verifica que el sitio pertenezca al usuario).
|
Consulta un ejemplo de solicitud de eliminación. |
getToken | Obtiene el token de verificación para colocarlo en el sitio web del usuario autenticado. Cuerpo de la solicitud:
|
Consulta un ejemplo de solicitud getToken. |
Ejemplos de llamadas a la API
En esta sección, se da por sentado que tú (el desarrollador) también eres el usuario autenticado, como será el caso cuando pruebes la API por primera vez con tus propios datos de prueba.
Verifica un sitio nuevo
Para verificar un sitio,
- Primero, llama a getToken para solicitar un token de verificación.
- Coloca el token en tu sitio con el método que elijas.
- Pídele a Google que verifique que el sitio es tuyo con la operación insert.
getToken (requiere autorización)
POST https://www.googleapis.com/siteVerification/v1/token?access_token=
oauth2-token
Solicitud:
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"
}
}
Respuesta:
{ "token": "google12cfc68677988bb4.html", "method": "FILE" }
Insertar (requiere autorización)
POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=
oauth2-token
Solicitud:
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"
}
}
Respuesta:
{ "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
Recuperar información sobre los recursos web verificados
Para recuperar la lista completa de tus sitios y dominios verificados, llama a list. Para recuperar información de un solo recurso web, puedes llamar a get.
Lista (requiere autorización)
GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=
oauth2-token
Solicitud:
GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token
Respuesta:
{ "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" } } ] }
Obtener (requiere autorización)
GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
Solicitud:
GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Respuesta:
{ "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
Modificar información de verificación
Puedes llamar a update para delegar y revocar la propiedad. Para quitar la propiedad, llama a delete.
Actualización (requiere autorización)
PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
Solicitud:
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"
}
}
Respuesta:
{ "owners": [ "myself@example.com", "another@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
Borrar (requiere autorización)
DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
Solicitud:
DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Respuesta:
Código de estado HTTP 204 (sin contenido), que indica que la prueba se realizó correctamente.