Kinsta API

Kinsta’s REST API (Application Programming Interface) is een krachtig hulpmiddel dat is ontworpen om developers eenvoudig 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 ophalen, acties kunt uitvoeren en taken kunt automatiseren.

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

Om in contact te komen met andere developers en diepgaande tutorials, tips en best practices te vinden voor het gebruik van Kinsta’s REST API, bekijk de Kinsta API categorie van ons Kinsta Community forum.

Vereisten

Om Kinsta’s API 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.

Authenticatie en gebruikerstoegang (API sleutel)

Om toegang te krijgen tot en gebruik te maken van de API met je account, moet je eerst een API-sleutel genereren in MyKinsta. Om te beginnen ga je naar de pagina API-sleutels (Je naam > Bedrijfsinstellingen > API sleutels) en klik je op API sleutel aanmaken.

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

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. Een API sleutel die is gegenereerd door een Company Developer heeft bijvoorbeeld niet dezelfde toegang als een sleutel die is gegenereerd door een Company Owner of Company Administrator.

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

API endpoints

Met de API van Kinsta kun je de volgende acties uitvoeren:

WordPress Hosting

• Ontvang een lijst met WordPress sites van je bedrijf, details over een specifieke site en details over de omgeving van een site.
• Maak een nieuwe WordPress site, kloon een bestaande site, maak een lege site zonder WordPress en verwijder een site.
• Maak een nieuwe testomgeving aan, zet een testomgeving live en verwijder een testomgeving.
• Verwijder de cache van een site, herstart en update PHP en krijg een lijst met geweigerde IP adressen.
• Krijg een lijst met plugins en thema’s voor je site en werk ze bij.
• Voeg een domein toe of verwijder het.
• Wis de cache van de edge en CDN op je site.
• Verkrijg een lijst met backups van je site en een lijst met downloadbare backups, herstel een backup naar je site en verwijder een backup.
• Verkrijg de logbestanden van je site.

Statische Site Hosting

• Verkrijg een lijst met statische sites van je bedrijf en details over een specifieke site, werk de instellingen van je site bij en verwijder een site.
• Verkrijg de deployment-details van een statische site en deploy je site handmatig of programmatisch.

Applicatie Hosting

• Verkrijg een lijst met applicaties van je bedrijf en details over een specifieke applicatie, inclusief de implementatiedetails en -processen, werk de instellingen van de applicatie bij en verwijder een applicatie.
• Verkrijg de implementatiedetails van een applicatie en deploy je applicatie handmatig of programmatisch.
• Informatie ophalen uit de analytics van je applicatie.
• Een interne verbinding tussen je applicatie en database maken.
• CDN en edge caching inschakelen en de cache voor beide wissen.

Database Hosting

• Een lijst met databases van je bedrijf en details over een specifieke database opvragen, een nieuwe database maken, de database-instellingen bijwerken en een database verwijderen.

Bedrijf

• Een lijst met gebruikers van je bedrijf, inclusief hun e-mailadres, volledige naam en een link naar hun profielfoto.

Gebruikelijke gevallen

Rapportage

API’s kunnen worden gebruikt om gegevens uit te lezen, zodat je je eigen rapporten kunt maken of Kinsta Diensten kunt integreren in je interne volgsystemen. Als je bijvoorbeeld een agentschap hebt en een applicatie gebruikt die al je klanten opsomt, 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.

Geplande taken

Je kunt je eigen applicatie maken om ’s nachts taken in 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 om de onderbreking voor bezoekers van je site tot een minimum te beperken.

Beheer van de site

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 automatisch een nieuwe WordPress site/installatie toevoegen met behulp van de API. Als je bijvoorbeeld een bureau runt en het aanmaken van een site wilt automatiseren zonder elke keer in te 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 optie om een WordPress Multisite installatie aan te maken (is_multisite TRUE) en een subdomein (is_subdomain_multisite TRUE) of subdirectory (is_subdomain_multisite FALSE) installatie te configureren.

Gebruik het eindpunt Operations om de status van het aanmaken van een site te controleren.

Operationele status controleren

Voor mogelijk langlopende operaties (bijv. sitecreatie, cache wissen, PHP herstarten, etc.) reageert de API niet onmiddellijk met het resultaat. Dit helpt een mogelijke geblokkeerde server thread of gateway time-out te voorkomen doordat een bewerking lang duurt.

Gebruik het eindpunt /operations om de status van een bewerking te controleren. Als je een bewerking start, zal de onmiddellijke respons van de API een operation_id bevatten om te gebruiken met het /operations endpoint. Voor meer details en voorbeelden, zie de Operatie referentie.

Limieten

Om te voorkomen dat onze API wordt overspoeld met te veel verzoeken, is het aantal verzoeken per minuut beperkt tot het volgende:

• 120 verzoeken per minuut per bedrijfs-ID geïdentificeerd aan de hand van de API-sleutel.
• 1000 verzoeken per minuut per IP adres. Dit wordt van kracht als je toegang hebt tot meerdere bedrijven.
• 5 verzoeken per minuut voor het aanmaken van bronnen, bijvoorbeeld het maken van een WordPress site.

Controleer de RateLimit headers in de meest recente API respons om je huidige rate limit status te zien. Het is momenteel niet mogelijk om de tarieflimiet te verhogen.

Problemen oplossen

Als je een verzoek indient bij een endpoint 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 nodig hebt tot dat eindpunt, moet een Company Owner of Company Administrator een API sleutel voor je genereren.

API referentie

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