API Kinsta

L’API REST de Kinsta (Application Programming Interface) est un outil puissant conçu pour permettre aux développeurs d’accéder et d’interagir facilement avec votre compte et vos projets Kinsta. Notre API offre un moyen rationalisé et efficace de travailler avec notre plateforme, vous permettant de récupérer des données, d’effectuer des actions et d’automatiser des tâches de manière efficace.

Pour plus de détails sur les points de terminaison de l’API, pour télécharger notre spécification OpenAPI et pour tester les points de terminaison, consultez notre référence API.

Pour vous connecter avec d’autres développeurs et trouver des tutoriels approfondis, des conseils et des meilleures pratiques pour utiliser l’API REST de Kinsta, consultez la catégorie API Kinsta de notre forum Kinsta Community.

Pré-requis

Pour utiliser l’API de Kinsta, vous devez avoir un compte et au moins un site WordPress, une application ou une base de données dans MyKinsta. Vous devrez également générer une clé API pour vous authentifier et accéder à votre compte via l’API.

Authentification et accès utilisateur (clé API)

Pour accéder et utiliser l’API avec votre compte, vous devrez d’abord générer une clé API dans MyKinsta. Pour commencer, allez sur la page des clés API (Votre nom > Réglages de l’entreprise > Clés API) et cliquez sur Créer une clé API.

1. Choisissez une date d’expiration ou définissez une date de début personnalisée et un nombre d’heures pour l’expiration de la clé.
2. Donnez un nom à la clé.
3. Cliquez sur Générer.

Lorsque la clé API est fournie, c’est la seule fois où vous pouvez la voir. Veillez à la copier et à la conserver en lieu sûr.

Les propriétaires, les administrateurs et les développeurs de l’entreprise peuvent créer des clés d’API. Le niveau d’accès à l’API dépend de l’accès de l’utilisateur. Par exemple, une clé API générée par un développeur d’entreprise n’aura pas le même accès qu’une clé générée par un propriétaire ou un administrateur d’entreprise.

Vous pouvez générer plusieurs clés API, qui sont répertoriées sur la page Clés API. Si vous devez révoquer une clé API, cliquez sur Révoquer en regard de celle que vous souhaitez révoquer.

Points de terminaison API

Avec l’API de Kinsta, vous pouvez effectuer les actions suivantes :

Hébergement WordPress

• Obtenir une liste des sites WordPress de votre entreprise, des détails sur un site spécifique et des détails sur l’environnement d’un site.
• Créer un nouveau site WordPress, cloner un site existant, créer un site vide sans WordPress et supprimer un site.
• Créer un nouveau site de staging, pousser un environnement de staging en production et supprimer un environnement de staging.
• Vider le cache d’un site, redémarrer et mettre à jour le PHP, et obtenir une liste des adresses IP refusées.
• Obtenir une liste des extensions et thèmes de votre site et les mettre à jour.
• Ajouter ou retirer un domaine.
• Vider le cache edge et le cache CDN de votre site.
• Obtenir une liste des sauvegardes de votre site et une liste des sauvegardes téléchargeables, restaurer une sauvegarde sur votre site et supprimer une sauvegarde.
• Obtenir les fichiers journaux du site.

Hébergement de sites statiques

• Obtenir une liste des sites statiques de votre entreprise et des détails sur un site spécifique, mettre à jour les réglages de votre site et supprimer un site.
• Obtenez les détails de déploiement d’un site statique et déployez votre site manuellement ou par programmation.

Hébergement d’applications

• Obtenez une liste des applications de votre entreprise et des détails sur une application spécifique, y compris les détails et les processus de déploiement, mettez à jour les réglages de l’application et supprimez une application.
• Obtenez les détails de déploiement d’une application et déployez votre application manuellement ou par programmation.
• Obtenez des informations à partir des statistiques de votre application.
• Créez une connexion interne entre votre application et la base de données.
• Activez le CDN et le cache edge et videz le cache pour les deux.

Hébergement de bases de données

• Obtenez une liste des bases de données de votre entreprise et des détails sur une base de données spécifique, créez une nouvelle base de données, mettez à jour les réglages de la base de données et supprimez une base de données.

Entreprise

• Obtenez une liste des utilisateurs de votre entreprise, y compris leur adresse e-mail, leur nom complet et un lien vers leur photo de profil.

Cas d’utilisation courants

Rapports

Les API peuvent être utilisées pour lire des données afin que vous puissiez créer vos propres rapports ou intégrer les services Kinsta à vos systèmes de suivi internes. Par exemple, si vous utilisez une agence et une application qui liste tous vos clients, vous pouvez utiliser l’API pour lister tous les sites WordPress, applications et bases de données hébergés par Kinsta appartenant à chaque client.

Tâches planifiées

Vous pouvez créer votre propre application pour planifier des tâches pendant la nuit qui peuvent avoir un impact sur les performances de votre site ou entraîner des temps d’arrêt. Par exemple, vider le cache du site pendant la nuit peut aider à minimiser les perturbations pour les visiteurs de votre site.

Gestion de site

En utilisant Node.js avec l’API, vous pouvez créer un Slackbot de gestion de site pour gagner du temps et vous aider à gérer vos sites plus efficacement. Vous pouvez utiliser le Slackbot pour des tâches telles que vérifier l’état d’un site, vider le cache d’un site et redémarrer le moteur PHP d’un site.

Création de sites WordPress

Vous pouvez ajouter un nouveau site WordPress/une nouvelle installation automatiquement à l’aide de l’API. Par exemple, si vous utilisez une agence et souhaitez automatiser le processus de création de site sans avoir à vous connecter à MyKinsta à chaque fois, vous pouvez utiliser l’API pour créer le site et installer WooCommerce, Yoast SEO et Easy Digital Downloads.

Vous avez également la possibilité de créer une installation WordPress Multisite (is_multisite TRUE) et de configurer une installation de sous-domaine (is_subdomain_multisite TRUE) ou de sous-répertoire (is_subdomain_multisite FALSE).

Pour vérifier l’état de la création du site, utilisez le point de terminaison Operations.

Vérifier l’état de l’opération

Pour les opérations susceptibles de durer longtemps (par exemple, la création d’un site, la suppression du cache, le redémarrage de PHP, etc.), l’API ne répond pas immédiatement avec le résultat. Cela permet d’éviter un éventuel blocage du thread du serveur ou un dépassement de délai de la passerelle en raison d’une opération qui prend beaucoup de temps.

Pour vérifier le statut d’une opération, utilisez le point de terminaison /operations. Lorsque vous lancez une opération, la réponse immédiate de l’API comprendra un operation_id à utiliser avec le point de terminaison /operations. Pour plus de détails et d’exemples, consultez la référence Opérations.

Limite de débit

Afin de protéger notre API contre un trop grand nombre de requêtes, le nombre de requêtes par minute est limité comme suit :

• 120 requêtes par minute par ID d’entreprise identificateur depuis la clé API.
• 1000 requêtes par minute par adresse IP. Ceci s’applique si vous avez accès à plusieurs entreprises.
• 5 requêtes par minute pour la création de ressources, par exemple la création d’un site WordPress.

Pour connaître votre état actuel de limite de débit, veuillez vérifier les en-têtes RateLimit dans la réponse API la plus récente. Il n’est actuellement pas possible d’augmenter la limite de débit.

Résolution des problèmes

Si vous faites une requête à un point de terminaison auquel votre clé API n’a pas accès, vous recevrez un message d’erreur vous indiquant que vous n’avez pas accès à ce point de terminaison. Si vous avez besoin d’accéder à ce point de terminaison, un propriétaire ou un administrateur de l’entreprise devra générer une clé API pour vous.

Référence API

Pour obtenir tous les détails sur les points de terminaison d’API disponibles, pour télécharger notre spécification OpenAPI et pour essayer les points de terminaison, consultez notre référence API.