L’API REST (Application Programming Interface) de Kinsta 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.

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.

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 dans vos systèmes de suivi internes. Par exemple, si vous utilisez une application qui répertorie tous vos clients, vous pouvez utiliser l’API pour lister tous les sites WordPress hébergés par Kinsta, les applications et les bases de données appartenant à chaque client.

Tâches planifiées

Vous pouvez créer votre propre application pour planifier pendant la nuit des tâches susceptibles d’avoir un impact sur les performances de votre site ou de provoquer des temps d’arrêt. Par exemple, l’effacement du 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 vous faire 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/installation WordPress automatiquement à l’aide de l’API. Par exemple, si vous gérez une agence et que vous 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 un sous-domaine (is_subdomain_multisite TRUE) ou un sous-répertoire (is_subdomain_multisite FALSE).

Pour vérifier l’état de la création d’un site, utilisez le point de terminaison Opérations.

Authentification et accès des utilisateurs

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 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.

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. ), 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

Pour éviter que notre API ne soit submergée par un trop grand nombre de requêtes, le nombre de requêtes par minute est limité à 60. Il existe une exception pour la création de sites, qui est limitée à 5 requêtes par minute.

Pour connaître l’état actuel de votre limite de débit, vérifiez les en-têtes RateLimit dans la dernière réponse de l’API :

RateLimit-Limit: 60

RateLimit-Remaining: 50

RateLimit-Reset: 60

Actuellement, il n’est 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.

Documentation similaire

Contenu référencé