Kinsta’s REST API (Application Programming Interface) is een krachtige tool die is ontworpen om developers gemakkelijk toegang te geven tot en te laten communiceren met je Kinsta account en projecten. Onze API biedt een gestroomlijnde en efficiënte manier om met ons platform te werken, zodat je efficiënt gegevens kunt opvragen, acties kunt uitvoeren en taken kunt automatiseren.

Voorwaarden

Om de API van Kinsta te gebruiken moet je een account hebben en ten minste één WordPress site, applicatie of database in MyKinsta. Je moet ook een API sleutel genereren om je te authenticeren en toegang te krijgen tot je account via de API.

Use cases

Rapportage

API’s kunnen worden gebruikt om gegevens te lezen, zodat je je eigen rapporten kunt maken of Kinsta diensten kunt integreren in je interne trackingsysteem. Als je bijvoorbeeld een bureau hebt en een applicatie gebruikt die al je klanten vermeldt, kun je de API gebruiken om een lijst te maken van alle door Kinsta gehoste WordPress sites, applicaties en databases die bij elke klant horen.

Plannen van taken

Je kunt je eigen applicatie maken om ’s nachts taken te plannen die de prestaties van je site kunnen beïnvloeden of downtime kunnen veroorzaken. Zo kan bijvoorbeeld het ’s nachts wissen van de cache van de site helpen de verstoring voor de bezoekers van je site tot een minimum te beperken.

Sitebeheer

Met Node.js en de API kun je een Slackbot voor sitebeheer maken om tijd te besparen en je sites efficiënter te beheren. Je kunt de Slackbot gebruiken voor taken als het controleren van de sitestatus, het wissen van de cache van een site en het herstarten van de PHP engine van een site.

WordPress site maken

Je kunt een nieuwe WordPress site/installatie automatisch toevoegen met behulp van de API. Als je bijvoorbeeld een bureau runt en het aanmaken van een site wilt kunnen automatiseren zonder elke keer in te hoeven loggen op MyKinsta, kun je de API gebruiken om de site aan te maken en WooCommerce, Yoast SEO en Easy Digital Downloads te installeren.

Je hebt ook de mogelijkheid om een WordPress Multisite installatie (is_multisite TRUE) te maken en een subdomein (is_subdomain_multisite TRUE) of subdirectory (is_subdomain_multisite FALSE) installatie.

Om de status van het aanmaken van een site te controleren, gebruik je het Operations eindpunt.

Authenticatie en gebruikerstoegang

Om de API met je account te kunnen gebruiken, moet je eerst een API sleutel genereren in MyKinsta. Ga om te beginnen naar de pagina API-sleutels (Je naam > Bedrijfsinstellingen > API sleutels) en klik op API sleutel aanmaken.

  1. Kies een vervaldatum of stel een aangepaste begindatum en het aantal uren in dat de sleutel moet verlopen.
  2. Geef de sleutel een naam.
  3. Klik op Genereren.

Wanneer de API sleutel is verstrekt, is dit de enige keer dat je hem kunt zien. Zorg ervoor dat je hem kopieert en ergens veilig bewaart.

Company Owners, Company Administrators en Company Developers kunnen API sleutels aanmaken. Het niveau van toegang tot de API hangt af van de toegang van de gebruiker. Bijvoorbeeld, een API sleutel gegenereerd door een Company Developer zal niet dezelfde toegang hebben als een sleutel gegenereerd door een Company Owner of Company Administrator.

Je kunt meerdere API sleutels genereren, die staan vermeld op de pagina API sleutels. Als je een API-sleutel moet intrekken, klik je op Intrekken naast de sleutel die je wilt intrekken.

Operatiestatus controleren

Voor mogelijk langlopende operaties (bijv. site aanmaken, cache wissen, PHP herstarten, enz.) reageert de API niet onmiddellijk met het resultaat. Dit helpt voorkomen dat een mogelijke geblokkeerde server thread of gateway timeout ontstaat doordat een bewerking lang duurt.

Gebruik het eindpunt /operations om de status van een operatie te controleren. Als je een operatie start, bevat het onmiddellijke antwoord van de API een operation_id om te gebruiken met het /operations eindpunt. Voor meer details en voorbeelden, zie de Operations referentie.

Limieten

Om te voorkomen dat onze API wordt overspoeld met te veel verzoeken, is het aantal verzoeken per minuut beperkt tot 60. Er is een uitzondering voor het aanmaken van sites, dat beperkt is tot 5 verzoeken per minuut.

Controleer de RateLimit headers in de meest recente API respons om je huidige rate limit status te zien:

RateLimit-Limit: 60

Resterende RateLimit: 50

RateLimit-Reset: 60

Momenteel is het niet mogelijk de limieten te verhogen.

Problemen oplossen

Als je een verzoek doet naar een eindpunt waar je API sleutel geen toegang toe heeft, krijg je een foutmelding om je te laten weten dat je geen toegang hebt. Als je toegang tot dat eindpunt nodig hebt, zal een bedrijfseigenaar of beheerder een API sleutel voor je moeten genereren.

API referentie

Voor volledige details over beschikbare API eindpunten, om onze OpenAPI specificatie te downloaden, en om eindpunten uit te proberen, zie onze API Referentie.

Verwante documentatie

Inhoud waarnaar wordt verwezen