Kinsta API
Die REST-API (Application Programming Interface) von Kinsta ist ein leistungsfähiges Werkzeug, das Entwicklern den einfachen Zugriff auf und die Interaktion mit deinem Kinsta-Konto und deinen Projekten ermöglicht. Unsere API bietet eine optimierte und effiziente Möglichkeit, mit unserer Plattform zu arbeiten und Daten abzurufen, Aktionen durchzuführen und Aufgaben zu automatisieren.
Alle Details zu den verfügbaren API-Endpunkten, die OpenAPI-Spezifikation zum Herunterladen und das Ausprobieren der Endpunkte findest du in unserer API-Referenz.
Um dich mit anderen Entwicklern auszutauschen und ausführliche Anleitungen, Tipps und Best Practices zur Nutzung der Kinsta-REST-API zu finden, besuche die Kategorie Kinsta-API in unserem Kinsta-Community-Forum.
Voraussetzungen
Um die Kinsta-API nutzen zu können, brauchst du ein Konto und mindestens eine WordPress-Site, -Anwendung oder -Datenbank in MyKinsta. Außerdem musst du einen API-Schlüssel erstellen, um dich zu authentifizieren und über die API auf dein Konto zuzugreifen.
Häufige Anwendungsfälle
Berichterstattung
Mit APIs kannst du Daten auslesen, um deine eigenen Berichte zu erstellen oder Kinsta-Dienste in deine internen Tracking-Systeme zu integrieren. Wenn du zum Beispiel eine Agentur betreibst und eine Anwendung verwendest, die alle deine Kunden auflistet, kannst du die API nutzen, um alle von Kinsta gehosteten WordPress-Websites, Anwendungen und Datenbanken aufzulisten, die zu den einzelnen Kunden gehören.
Geplante Aufgaben
Du kannst deine eigene Anwendung erstellen, um über Nacht Aufgaben zu planen, die die Leistung deiner Website beeinträchtigen oder zu Ausfallzeiten führen können. Wenn du z. B. den Cache deiner Website über Nacht löschst, kann das dazu beitragen, die Störungen für die Besucher deiner Website zu minimieren.
Website-Verwaltung
Mit Node.js und der API kannst du einen Slackbot für die Website-Verwaltung erstellen, der dir Zeit spart und dir hilft, deine Websites effizienter zu verwalten. Mit dem Slackbot kannst du z. B. den Website-Status überprüfen, den Cache einer Site leeren und die PHP-Engine einer Website neu starten.
WordPress-Seiten erstellen
Du kannst eine neue WordPress-Site/Installation automatisch über die API hinzufügen. Wenn du z. B. eine Agentur betreibst und den Prozess der Website-Erstellung automatisieren möchtest, ohne dich jedes Mal bei MyKinsta anmelden zu müssen, kannst du die API nutzen, um die Website zu erstellen und WooCommerce, Yoast SEO und Easy Digital Downloads zu installieren.
Du hast auch die Möglichkeit, eine WordPress Multisite-Installation (is_multisite TRUE) zu erstellen und eine Subdomain (is_subdomain_multisite TRUE) oder ein Unterverzeichnis (is_subdomain_multisite FALSE) zu konfigurieren.
Um den Status der Site-Erstellung zu überprüfen, verwende den Endpunkt Vorgänge.
Authentifizierung und Benutzerzugang
Um mit deinem Konto auf die API zugreifen und sie nutzen zu können, musst du zunächst einen API-Schlüssel in MyKinsta erstellen. Gehe dazu auf die Seite API-Schlüssel (Dein Name > Unternehmenseinstellungen > API-Schlüssel) und klicke auf API-Schlüssel erstellen.
- Wähle ein Ablaufdatum oder lege ein benutzerdefiniertes Startdatum und die Anzahl der Stunden fest, nach denen der Schlüssel abläuft.
- Gib dem Schlüssel einen Namen.
- Klicke auf Erzeugen.
Wenn der API-Schlüssel bereitgestellt wird, ist dies das einzige Mal, dass du ihn sehen kannst. Stelle sicher, dass du ihn kopierst und an einem sicheren Ort aufbewahrst.
Betriebseigentümer, Betriebsadministratoren und Betriebsentwickler können API-Schlüssel erstellen. Die Zugriffsstufe auf die API hängt von der Zugangsberechtigung des Nutzers ab. Ein API-Schlüssel, der von einem Unternehmensentwickler erstellt wurde, hat zum Beispiel nicht den gleichen Zugang wie ein Schlüssel, der von einem Unternehmensinhaber oder Administrator erstellt wurde.
Du kannst mehrere API-Schlüssel erstellen, die auf der Seite API-Schlüssel aufgelistet sind. Wenn du einen API-Schlüssel widerrufen musst, klicke auf Widerruf neben dem Schlüssel, den du widerrufen möchtest.
Vorgangsstatus prüfen
Bei potenziell langwierigen Vorgängen (z. B. Website-Erstellung, Löschen des Cache, Neustart von PHP usw.) antwortet die API nicht sofort mit dem Ergebnis. So kannst du verhindern, dass ein Server-Thread oder ein Gateway-Timeout blockiert wird, weil ein Vorgang lange dauert.
Um den Status eines Vorgangs zu überprüfen, verwendest du den Endpunkt /operations. Wenn du einen Vorgang startest, enthält die unmittelbare Antwort der API eine operation_id, die du mit dem Endpunkt /operations verwenden kannst. Weitere Einzelheiten und Beispiele findest du in der Referenz für Vorgänge.
Ratenbegrenzung
Um zu verhindern, dass unsere API mit zu vielen Anfragen überflutet wird, ist die Anzahl der Anfragen pro Minute auf 60 begrenzt. Es gibt eine Ausnahme für die Erstellung von Websites, die auf 5 Anfragen pro Minute begrenzt ist.
Um den aktuellen Status deines Ratenlimits zu sehen, überprüfe die RateLimit-Header in der letzten API-Antwort:
RateLimit-Limit: 60
RateLimit-Restmenge: 50
RateLimit-Reset: 60
Derzeit ist es nicht möglich, das Ratenlimit zu erhöhen.
Fehlersuche
Wenn du eine Anfrage an einen Endpunkt stellst, auf den dein API-Schlüssel keinen Zugriff hat, erhältst du eine Fehlermeldung, die dir mitteilt, dass du keinen Zugriff hast. Wenn du Zugang zu diesem Endpunkt brauchst, muss ein Firmeninhaber oder Administrator einen API-Schlüssel für dich erstellen.
API-Referenz
Ausführliche Informationen zu den verfügbaren API-Endpunkten, zum Herunterladen unserer OpenAPI-Spezifikation und zum Ausprobieren der Endpunkte findest du in unserer API-Referenz.