La API REST de Kinsta (Application Programming Interface o Interfaz de Programación de Aplicaciones) es una potente herramienta diseñada para permitir a los desarrolladores acceder e interactuar fácilmente con su cuenta y proyectos de Kinsta. Nuestra API proporciona una forma ágil y eficaz de trabajar con nuestra plataforma, permitiéndote recuperar datos, realizar acciones y automatizar tareas de forma eficiente.

Requisitos Previos

Para utilizar la API de Kinsta, debes tener una cuenta y al menos un sitio de WordPress, aplicación o base de datos en MyKinsta. También necesitarás generar una clave API para autenticarte y acceder a tu cuenta a través de la API.

Casos de Uso Comunes

Informes

Las API se pueden utilizar para leer datos de modo que puedas crear tus propios informes o integrar los Servicios Kinsta en tus sistemas de seguimiento internos. Por ejemplo, si diriges una agencia y utilizas una aplicación que lista a todos tus clientes, puedes utilizar la API para listar todos los sitios de WordPress, aplicaciones y bases de datos alojados en Kinsta que pertenezcan a cada cliente.

Tareas Programadas

Puedes crear tu propia aplicación para programar tareas durante la noche que puedan afectar al rendimiento de tu sitio o causar tiempo de inactividad. Por ejemplo, limpiar la caché del sitio durante la noche puede ayudar a minimizar las interrupciones para los visitantes de tu sitio.

Gestión de Sitios

Usando Node.js con la API, puedes crear un Slackbot de gestión de sitios que te ahorre tiempo y te ayude a gestionar tus sitios de forma más eficiente. Puedes utilizar el Slackbot para tareas como comprobar el estado del sitio, limpiar la caché de un sitio y reiniciar el motor PHP de un sitio.

Creación de Sitios WordPress

Puedes añadir un nuevo sitio/instalación de WordPress automáticamente utilizando la API. Por ejemplo, si diriges una agencia y quieres poder automatizar el proceso de creación del sitio sin tener que iniciar sesión en MyKinsta cada vez, puedes utilizar la API para crear el sitio e instalar WooCommerce, Yoast SEO y Easy Digital Downloads.

También tiene la opción de crear una instalación WordPress Multisitio (is_multisite TRUE) y configurar una instalación subdominio (is_subdomain_multisite TRUE) o subdirectorio (is_subdomain_multisite FALSE).

Para comprobar el estado de la creación del sitio, utiliza el endpoint Operaciones.

Autenticación y Acceso de Usuarios

Para acceder y utilizar la API con tu cuenta, primero tendrás que generar una clave API en MyKinsta. Para empezar, ve a la página API Keys (Tu nombre > Configuración de la empresa > API Keys) y haz clic en Crear API Key.

  1. Elige una fecha de caducidad o establece una fecha de inicio personalizada y un número de horas para que caduque la clave.
  2. Dale un nombre a la clave.
  3. Haz clic en Generar.

Cuando se proporciona la API key, será la única vez que la podrás ver. Asegúrate de copiarla y guardarla en un lugar seguro.

Los propietarios de empresas, administradores de empresas y desarrolladores de empresas pueden crear API keys. El nivel de acceso a la API dependerá del acceso del usuario. Por ejemplo, una API key generada por un desarrollador de empresa no tendrá el mismo acceso que una generada por el propietario o administrador de una empresa.

Puedes generar varias API keys, que se enumeran en la página API Keys. Si necesitas revocar una API key, haz clic en Revocar junto a la que quieras revocar.

Comprobar el Estado de la Operación

Para operaciones potencialmente de larga duración (por ejemplo, la creación de un sitio, la limpieza de la caché, el reinicio de PHP, etc.) la API no responde inmediatamente con el resultado. Esto ayuda a evitar un posible bloqueo del hilo del servidor o un tiempo de espera de la pasarela debido a que una operación tarda mucho tiempo.

Para comprobar el estado de una operación, utiliza el endpoint /operations. Cuando inicies una operación, la respuesta inmediata de la API incluirá un operation_id para utilizarlo con el endpoint /operations. Para más detalles y ejemplos, consulta la referencia de Operaciones.

Límite de Velocidad

Para evitar que nuestra API se vea inundada por demasiadas solicitudes, el número de solicitudes por minuto está limitado a 60. Hay una excepción para la creación de Sitios, que está limitada a 5 peticiones por minuto.

Para ver el estado actual de tu límite de velocidad, comprueba las cabeceras RateLimit en la respuesta API más reciente:

RateLimit-Limit: 60

RateLimit-Remaining: 50

RateLimit-Reset: 60

Actualmente, no es posible aumentar el límite de velocidad.

Solución de Problemas

Si realizas una solicitud a un endpoint al que tu API key no tiene acceso, recibirás un mensaje de error para informarte de que no tienes acceso. Si necesitas acceder a ese endpoint, un propietario o administrador de la empresa tendrá que generar una API key para ti.

Referencia de la API

Para obtener todos los detalles sobre los endpoints de la API disponibles, descargar nuestra especificación OpenAPI y probar los endpoints, consulta nuestra Referencia de la API.

Documentación Relacionada

Contenido de Referencia