La REST API (Application Programming Interface) di Kinsta è un potente strumento progettato per consentire agli sviluppatori di accedere e interagire facilmente con l’account e i progetti Kinsta dei nostri clienti. Grazie alla REST API, è possibile interagire facilmente con la nostra piattaforma, recuperare dati, eseguire azioni e automatizzare attività.

Prerequisiti

Per utilizzare l’API di Kinsta, è necessario avere un account e almeno un sito WordPress, un’applicazione o un database in MyKinsta. Sarà inoltre necessario generare una chiave API per l’autenticazione e l’accesso all’account tramite l’API.

Casi d’Uso

Reporting

Le API possono essere utilizzate per leggere i dati e creare report o integrare i Servizi Kinsta nei propri sistemi di monitoraggio interni. Ad esempio, se si gestisce un’agenzia e si utilizza un’applicazione che elenca tutti i clienti, è possibile utilizzare l’API per elencare tutti i siti WordPress, applicazioni, e database di ciascun cliente ospitati su Kinsta.

Attività Programmate

È possibile creare un’applicazione per programmare le attività notturne che possono avere un impatto sulle prestazioni del sito o causare un’interruzione dell’attività. Ad esempio, la cancellazione della cache del sito durante la notte può permettere di ridurre al minimo le interruzioni per i visitatori del sito.

Gestione del sito

Utilizzando Node.js con l’API, è possibile creare uno Slackbot per gestire il sito per risparmiare tempo e gestire i siti in modo più efficiente. È possibile utilizzare Slackbot per attività come verificare lo stato del sito, svuotare la cache di un sito, e riavviare il motore PHP del sito.

Creazione di Siti WordPress

Grazie all’API, è possibile aggiungere un nuovo sito/installazione di WordPress automaticamente. Ad esempio, se si gestisce un’agenzia e si vuole automatizzare il processo di creazione del sito senza dover accedere ogni volta a MyKinsta, si può usare l’API per creare il sito e installare WooCommerce, Yoast SEO e Easy Digital Downloads.

L’API dà anche la possibilità di creare un’installazione di WordPress Multisite e configurare un sottodominio (is_multisite TRUE) o una sottodirectory (is_subdomain_multisite FALSE).

L’endpoint Operations permette di verificare lo stato di creazione del sito.

Autenticazione e Accesso degli Utenti

Per accedere e utilizzare l’API con il proprio account, bisognerà prima generare una chiave API in MyKinsta. Per iniziare, nella pagina delle chiavi API (Tuo nome > Impostazioni azienda > Chiavi API) fare clic su Genera chiave API.

  1. Scegliere una scadenza o impostare una data di inizio personalizzata e un numero di ore alla scadenza della chiave.
  2. Dare un nome alla chiave.
  3. Cliccare su Genera.

Il sistema fornirà la chiave API. Questo è l’unico momento in cui è possibile vederla. È necessario copiarla e di conservarla in un luogo sicuro.

Possono creare chiavi API i proprietari, gli amministratori e gli sviluppatori dell’azienda. Il livello di accesso all’API dipende dall’accesso dell’utente. Ad esempio, una chiave API generata da uno sviluppatore d’azienda non avrà lo stesso accesso di una chiave generata dal proprietario o dall’amministratore dell’azienda.

È possibile generare più chiavi API, elencate nella pagina delle chiavi API. Se si desidera revocare una chiave API, basta fare clic su Revoca accanto alla chiave che si vuole revocare.

Controllare lo stato delle operazioni

Per le operazioni potenzialmente lunghe (ad esempio la creazione di un sito, la cancellazione della cache, il riavvio di PHP, ecc.) l’API non risponde immediatamente con il risultato. Questo previene un possibile blocco del thread del server o un timeout del gateway a causa di un’operazione la cui esecuzione richieda molto tempo.

L’endpoint /operations permette di verificare lo stato di un’operazione. Quando si avvia un’operazione, la risposta immediata dell’API includerà un operation_id da utilizzare con l’endpoint /operations. Per maggiori informazioni ed esempi, si legga il riferimento alle Operazioni.

Limite di Richieste

Per evitare un utilizzo eccessivo dell’API, il numero di richieste al minuto è limitato a 60. C’è un’eccezione per la creazione di siti, che è limitata a 5 richieste al minuto.

Lo stato attuale del limite di richieste è riportato nelle intestazioni RateLimit della risposta API più recente:

RateLimit-Limit: 60

RateLimit-Remaining: 50

RateLimit-Reset: 60

Al momento non è possibile aumentare il limite di velocità.

Risoluzione dei Problemi

Se si fa una richiesta a un endpoint a cui la chiave API non ha accesso, si riceve un messaggio di errore che informa che non si ha accesso alla risorsa. Se si ha bisogno di accedere a quell’endpoint, un proprietario o un amministratore dell’azienda dovrà generare una nuova chiave API.

Documentazione dell’API

La Documentazione dell’API fornisce tutti i dettagli sugli endpoint disponibili. Nella documentazione è anche possibile scaricare le nostre specifiche OpenAPI e provare gli endpoint.

Documentazione Correlata

Contenuti di Riferimento