Kinsta’s REST API (Application Programming Interface) är ett kraftfullt verktyg som är utformat för att göra det enkelt för utvecklare att komma åt och interagera med ditt Kinsta-konto och projekt. Vårt API erbjuder ett strömlinjeformat och effektivt sätt att arbeta med vår plattform. Som ett resultat kan du hämta data, utföra åtgärder och automatisera uppgifter effektivt.
Förutsättningar
För att använda Kinsta’s API måste du ha ett konto och minst en WordPress-webbplats, applikation eller databas i MyKinsta. Du måste dessutom generera en API-nyckel för att autentisera och komma åt ditt konto via API.
Vanliga användningsområden
Rapportering
API: er kan användas för att läsa data så att du kan skapa dina egna rapporter eller integrera Kinsta-tjänster i dina interna spårningssystem. Om du exempelvis driver en agentur och använder en applikation som listar alla dina kunder, kan du använda API: et för att lista alla WordPress-webbplatser, applikationer och databaser som tillhör Kinsta och som tillhör varje klient.
Schemalagda uppgifter
Du kan skapa din egen applikation för att schemalägga uppgifter över natten som kan påverka webbplatsens prestanda eller orsaka driftstopp. Om du exempelvis rensar webbplatsens cache under natten kan du minimera störningarna för dina besökare.
Skapa WordPress-webbplats
Du kan lägga till en ny WordPress-webbplats/installation automatiskt med hjälp av API: et. Du kanske exempelvis driver en agentur och vill kunna automatisera webbplatsskapande-processen utan att behöva logga in på MyKinsta varje gång? Då kan du använda API: et för att skapa webbplatsen och installera WooCommerce, Yoast SEO och Easy Digital Downloads.
Du har dessutom möjlighet att skapa en WordPress multisides-installation och konfigurera en installation för underdomän (is_multisite TRUE
) eller underkatalog (is_subdomain_multisite FALSE
).
För att kontrollera statusen för skapandet av webbplatsen, använd Operations endpoint.
Autentisering och användaråtkomst
För att komma åt och använda API med ditt konto måste du först generera en API-nyckel i MyKinsta. För att komma igång, gå till sidan API-nycklar (Ditt namn > Företagsinställningar > API-nycklar) och klicka på Skapa API-nyckel.
- Välj ett utgångsdatum eller ställ in ett anpassat startdatum och antal timmar innan nyckeln löper ut.
- Ge nyckeln ett namn.
- Klicka på Generera.
När API-nyckeln tillhandahålls är detta den enda gången som du kan se den. Se därför till att du kopierar den och förvarar den på ett säkert ställe.
Företagsägare, företagsadministratörer och företagsutvecklare kan skapa API-nycklar. Åtkomstnivån till API: et beror på användarens åtkomst. En API-nyckel som skapas av en företagsutvecklare har exempelvis inte samma åtkomst som en nyckel som skapas av en företagsägare eller administratör.
Du kan generera flera API-nycklar, som listas på sidan API-nycklar. Om du behöver återkalla en API-nyckel klickar du på Återkalla bredvid den som du vill återkalla.
Kontrollera status för åtgärder
För potentiellt långvariga åtgärder (exempelvis skapande av webbplats, rensning av cache, omstart av PHP etc.) svarar API inte omedelbart med resultatet. Som ett resultat förhindras en potentiell blockerad servertråd eller gateway-timeout på grund av att en operation tar lång tid.
För att kontrollera statusen för en åtgärd, använd slutpunkten /operations
. När du startar en åtgärd kommer det omedelbara svaret från API: et att innehålla en operation_id
som ska användas med slutpunkten /operations
. Mer information och exempel finns i referensen Operationer.
Gräns för hastighet
För att skydda vårt API från att översvämmas av för många förfrågningar är antalet förfrågningar per minut begränsat till 60. Det finns dock ett undantag för skapande av webbplatser, som är begränsat till 5 förfrågningar per minut.
För att se din aktuella status för hastighetsbegränsning, kontrollera RateLimit-rubrikerna i det senaste API-svaret:
RateLimit-Gräns: 60
RateLimit-Resterande: 50
RateLimit-Återställning: 60
Det är för närvarande inte möjligt att öka hastighetsbegränsningen.
Felsökning
Om du gör en begäran till en slutpunkt som din API-nyckel inte har åtkomst till får du ett felmeddelande om att du inte har åtkomst. Om du behöver åtkomst till den slutpunkten måste en företagsägare eller administratör generera en API-nyckel åt dig.
API-referens
För fullständig information om tillgängliga API-slutpunkter, ladda ner vår OpenAPI-specifikation. Om du vill testa slutpunkter, se vår API-referens.
Relaterad dokumentation
- Lägg till en applikation
- Hur du lägger till en databas
- Lägg till en ny WordPress-installation/webbplats
- Applikationsanalys
- Databas-analys
- WordPress-analys i MyKinsta