API Kinsta
La API REST de Kinsta (Interfaz de Programación de Aplicaciones, ) es una potente herramienta diseñada para permitir a los desarrolladores acceder e interactuar fácilmente con tu 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.
Para obtener información completa sobre los endpoints de la API disponibles, descargar nuestra especificación OpenAPI y probar los endpoints, consulta nuestra Referencia de la API.
Para conectar con otros desarrolladores y encontrar tutoriales en profundidad, consejos y mejores prácticas para utilizar la API REST de Kinsta, consulta la categoría API Kinsta de nuestro foro de la Comunidad Kinsta.
Requisitos Previos
Para utilizar la API de Kinsta, debes tener una cuenta y al menos un sitio, aplicación o base de datos de WordPress en MyKinsta. También necesitarás generar una clave API para autenticarte y acceder a tu cuenta a través de la API.
Autenticación y acceso de usuarios (clave API)
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 Claves API (Tu nombre > Configuración de la empresa > Claves API) y haz clic en Crear Clave API.
- Elige una fecha de caducidad o establece una fecha de inicio personalizada y un número de horas para que caduque la clave.
- Dale un nombre a la clave.
- Haz clic en Generar.
Cuando se proporciona la clave API, es la única vez que puedes verla. Asegúrate de copiarla y guardarla en un lugar seguro.
Los propietarios de empresas, los administradores de empresas y los desarrolladores de empresas pueden crear claves API. El nivel de acceso a la API dependerá del acceso del usuario. Por ejemplo, una clave API generada por un desarrollador de empresa no tendrá el mismo acceso que una clave generada por el propietario o administrador de una empresa.
Puedes generar varias claves API, que se enumeran en la página Claves API. Si necesitas revocar una clave API, haz clic en Revocar junto a la que quieras revocar.
Endpoints de la API
Con la API de Kinsta, puedes realizar las siguientes acciones:
Alojamiento de WordPress
- Obtener una lista de los sitios de WordPress de tu empresa, detalles sobre un sitio específico y detalles sobre el entorno de un sitio.
- Crear un nuevo sitio de WordPress, clonar un sitio existente, crear un sitio vacío sin WordPress y eliminar un sitio.
- Crear un nuevo sitio staging, activar un entorno staging y eliminar un entorno staging.
- Borrar el caché de un sitio, reiniciar y actualizar el PHP, y obtener una lista de direcciones IP denegadas.
- Obtener una lista de los plugins y temas de tu sitio y actualizarlos.
- Añadir o eliminar un dominio.
- Borrar el caché edge y el caché CDN de tu sitio.
- Obtener una lista de las copias de seguridad de tu sitio y una lista de las copias de seguridad descargables, restaurar una copia de seguridad en tu sitio y eliminar una copia de seguridad.
- Obtener los archivos de registro de tu sitio.
Alojamiento de sitios estáticos
- Obtener una lista de los sitios estáticos de tu empresa y detalles sobre un sitio concreto, actualizar la configuración de tu sitio y eliminar un sitio.
- Obtener los detalles de Despliegue de un sitio estático y desplegar manual o programáticamente tu sitio.
Alojamiento de Aplicaciones
- Obtener una lista de las aplicaciones de tu empresa y detalles sobre una aplicación concreta, incluidos los detalles y procesos de despliegue, actualizar la configuración de la aplicación y eliminar una aplicación.
- Obtener los detalles de Despliegue de una aplicación y desplegar manual o programáticamente tu aplicación.
- Obtener información de las analíticas de tu aplicación.
- Crear una conexión interna entre tu aplicación y la base de datos.
- Activar la CDN y el Edge Caching y borrar el caché de ambos.
Alojamiento de Base de Datos
- Obtener una lista de las bases de datos de tu empresa y detalles sobre una base de datos específica, crear una nueva base de datos, actualizar la configuración de la base de datos y eliminar una base de datos.
Empresa
- Obtener una lista de los usuarios de tu empresa, incluyendo su dirección de correo electrónico, nombre completo y un enlace a su foto de perfil.
Casos de uso común
Informes
Las APIs se pueden utilizar para leer datos, de modo que puedas crear tus propios informes o integrar los Servicios Kinsta en tus sistemas internos de seguimiento. 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, borrar el caché del sitio durante la noche puede ayudar a minimizar las interrupciones para los visitantes de tu sitio.
Gestión del sitio
Utilizando 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, borrar el 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 tienes la opción de crear una instalación Multisitio de WordPress (is_multisite TRUE
) y configurar una instalación de subdominio (is_subdomain_multisite TRUE
) o subdirectorio (is_subdomain_multisite FALSE
).
Para comprobar el estado de la creación del sitio, utiliza el endpoint Operations.
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 Operaciones.
Límite de Velocidad
Para evitar que nuestra API se vea inundada con demasiadas solicitudes, el número de solicitudes por minuto está limitado a lo siguiente:
- 120 solicitudes por minuto por identificador de empresa identificado a partir de la clave API.
- 1000 solicitudes por minuto por dirección IP. Este límite se aplicaría si tienes acceso a varias empresas.
- 5 solicitudes por minuto para la creación de recursos, por ejemplo, la creación de un sitio de WordPress.
Para ver el estado actual de tu límite de velocidad, revisa las cabeceras RateLimit en la respuesta más reciente de la API. Actualmente no es posible aumentar dicho límite.
Solución de Problemas
Si realizas una solicitud a un endpoint al que tu clave API 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 clave API 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.