Comenzando con el API de PageSpeed.ONE
Martin MichálekActualizado 9/6/20265 minutos lecturaEste texto te guiará a través de los primeros pasos con el API de monitorización de PageSpeed.ONE. Lo que necesitas cumplir, dónde obtener la clave y cómo obtener una visión general de la velocidad de tus sitios web a partir de los datos del API.
Aquí ofrecemos una introducción rápida al tema. No sustituye la documentación completa del API.
¿Qué ofrece el API?
El API público está diseñado para automatizar el trabajo con los resultados de las pruebas:
- Puedes descargar métricas CrUX agregadas.
- Puedes leer el historial de puntuaciones de PageSpeed.ONE (SPS).
- Puedes consultar el estado del Vigilante.
- Puedes escribir notas en los gráficos.
¿Dónde está disponible el API?
El API público de PageSpeed.ONE opera en la siguiente URL:
URL de producción: https://api.pagespeed.one/.
Puedes realizar una primera prueba desde la línea de comandos de la siguiente manera:
curl https://api.pagespeed.one/health
Esto te devolverá el "estado de salud" del API, confirmando que todo funciona adecuadamente.
Automatiza el trabajo con datos de velocidad — métricas, Vigilante y notas en gráficos.
¿Qué necesito cumplir para acceder a los datos?
El acceso al API está vinculado a conjuntos de pruebas reales de PageSpeed.ONE. Las claves del API se asignan por equipo. Necesitas tener un plan y una configuración en el equipo que sea compatible con el API:
- Ser parte de un equipo que disponga de alguno de los conjuntos de pruebas de pago, como PLUS.
- Ser administrador en este equipo para poder generar claves del API.
Verifica si puedes ver la configuración del API tras iniciar sesión en configuración de equipo. Luego puedes proceder a configurar las claves del API.
Obtención de la clave del API
Los peticiones protegidas se autorizan con la clave de la organización (conocida como "Bearer token"). La clave pertenece a un equipo y todas las operaciones solo pueden realizarse sobre los datos de ese equipo.
- Inicia sesión en el monitoreo de PageSpeed.ONE en tu navegador.
- Selecciona el equipo correspondiente.
- Abre la configuración del equipo (organización).
- En la configuración, encuentra la sección para el API Público y gestión de claves.
- Antes de generar, elige el nivel de permisos:
- Solo lectura — para esta clave del API solo se permitirá la lectura de datos de velocidad (puedes asignarla, por ejemplo, a una agencia externa).
- Lectura y escritura — para operaciones que modifican datos, como crear notas en las pruebas (ten cuidado a quién le asignas la clave).
- Genera una nueva clave. Luego copia la clave en un gestor de contraseñas.
- Trata la clave con cuidado, como si fuera una contraseña: utiliza solo transferencias a través de HTTPS, nunca la almacenes en un repositorio; en caso de fuga de datos o periódicamente, revoca la clave y crea una nueva.
Ahora, en cada solicitud, envía el encabezado Authorization: Bearer <TU_CLAVE_API> y podrás utilizar nuestro API.
¿Cómo encuentro el hash de un conjunto de pruebas específico?
Los conjuntos de pruebas son unidades que ves en el tablero del equipo. En las pruebas PLUS, corresponden a la medición de un sitio web, su URL y su competencia.
El hash del conjunto de pruebas también se puede encontrar manualmente en la URL del conjunto de pruebas:
https:/app/r/7f3c9a2b1d4e8/
→ testHash en este caso es 7f3c9a2b1d4e8
La URL correcta del conjunto de pruebas se reconoce por la estructura /app/r/{testHash}/.
No utilices otros segmentos de la dirección (por ejemplo, el hash del equipo en la ruta /app/{algo}/dashboard).
También puedes obtener una lista completa de hashes válidos de conjuntos de pruebas para tu equipo (PLUS, START, incluidos los períodos de prueba; sin incluir las mediciones puramente GRATUITAS) a través de una llamada al API GET /v1/tests.
Primera prueba
Puedes listar todos los conjuntos de pruebas relevantes del equipo (ver arriba). O inmediatamente verificar un hash específico:
Intenta verificar si tienes acceso al conjunto de pruebas dado:
curl 'https://api.pagespeed.one/v1/tests/access-check?testHash=TEST_HASH' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer TU_CLAVE_API'
Reemplaza
TU_CLAVE_API— la clave del API, ver arriba,TEST_HASH— el hash del conjunto de pruebas de su URL, ver arriba.
Deberías recibir algo como:
{
"authorized": true,
"organizationHash": "HASH_DEL_EQUIPO",
"testHash": "TEST_HASH"
}
organizationHash corresponde al segmento del equipo en /app/{organizationHash}/dashboard (no es el id numérico de la base de datos).
También puedes probar esto en vivo en la documentación completa del API. Allí también encontrarás otras opciones de llamadas para lectura o escritura de datos.
Respuestas de error
Casos comunes:
- 401 — falta la clave, encabezado
Authorizationmal formado, o la clave no es reconocida, - 403 — clave válida pero el alcance no es suficiente (por ejemplo, clave solo de lectura para escritura),
- 500 — error inesperado del servidor.
El cuerpo de respuesta suele ser un pequeño JSON con un campo error (texto adecuado para el registro o UI; el contenido puede cambiar entre versiones).