L’API di Kinsta
L’API REST (Application Programming Interface) di Kinsta è un potente strumento progettato per consentire agli sviluppatori di accedere e interagire facilmente con il proprio account e progetti Kinsta. La nostra API offre un modo snello ed efficiente di lavorare con la nostra piattaforma, consentendo di recuperare dati, eseguire azioni e automatizzare attività in modo efficiente.
Per tutti i dettagli sugli endpoint API disponibili, per scaricare le nostre specifiche OpenAPI e per provare gli endpoint, consultate la nostra API Reference.
Per entrare in contatto con altri sviluppatori e trovare tutorial approfonditi, suggerimenti e best practice per l’utilizzo dell’API REST di Kinsta, visitate la categoria Kinsta API del nostro forum Kinsta Community.
Prerequisiti
Per utilizzare l’API di Kinsta, dovete avere un account e almeno un sito WordPress, un’applicazione o un database in MyKinsta. Sarà inoltre necessario generare una chiave API per autenticarsi e accedere al proprio account tramite l’API.
Casi d’uso comuni
Report
Le API possono essere utilizzate per leggere i dati in modo da poter creare i 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, si può usare l’API per elencare tutti i siti WordPress, le applicazioni e i database ospitati da Kinsta e appartenenti a ciascun cliente.
Attività programmate
È possibile creare la propria 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ò aiutare a ridurre al minimo le interruzioni per i visitatori del sito.
Gestione del sito
Utilizzando Node.js e l’API, potrete creare uno Slackbot per la gestione del sito che vi farà risparmiare tempo e vi aiuterà a gestire i siti in modo più efficiente. Potete usare lo Slackbot per attività come il controllo dello stato del sito, la cancellazione della cache del sito e il riavvio del motore PHP del sito.
Creazione di siti WordPress
È possibile aggiungere un nuovo sito/installazione di WordPress automaticamente utilizzando l’API. 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.
Avete anche la possibilità di creare un’installazione WordPress Multisito (is_multisite TRUE) e di configurare un sottodominio (is_subdomain_multisite TRUE) o una sottodirectory (is_subdomain_multisite FALSE).
Per verificare lo stato di creazione del sito, si può utilizzare l’endpoint Operations.
Autenticazione e accesso degli utenti
Per accedere e utilizzare l’API con il proprio account, sarà necessario prima generare una chiave API in MyKinsta. Per iniziare, andare alla pagina delle chiavi API (Nome > Impostazioni dell’azienda > Chiavi API) e cliccare su Crea chiave API.
- Scegliere una scadenza o impostare una data di inizio personalizzata e un numero di ore di scadenza della chiave.
- Dare un nome alla chiave.
- Cliccare su Genera.
Quando la chiave API viene fornita, è l’unico momento in cui è possibile vederla. Assicurarsi di copiarla e di conservarla in un luogo sicuro.
I proprietari, gli amministratori e gli sviluppatori dell’azienda possono creare chiavi API. Il livello di accesso all’API dipende dall’accesso dell’utente. Ad esempio, una chiave API generata da uno sviluppatore aziendale non avrà lo stesso accesso di una chiave generata dal proprietario o dall’amministratore dell’azienda.
È possibile generare più chiavi API, che sono elencate nella pagina delle chiavi API. Se è necessario revocare una chiave API, cliccare su Revoca accanto a quella 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 aiuta a prevenire un potenziale blocco del thread del server o un timeout del gateway a causa di un’operazione che richiede molto tempo.
Per verificare lo stato di un’operazione, usare l’endpoint /operations. Quando si avvia un’operazione, la risposta immediata dell’API includerà un operation_id da utilizzare con l’endpoint /operations. Per maggiori dettagli ed esempi, consultare la documentazione sulle Operazioni.
Rate limit
Per evitare che l’API venga sommersa da un numero eccessivo di richieste, il numero di richieste al minuto è limitato a 60. C’è un’eccezione per la creazione di siti, che è limitata a 5 richieste al minuto.
Per vedere lo stato attuale del rate limit, controllare gli header RateLimit nella risposta API più recente:
RateLimit-Limit: 60
RateLimit-Remaining: 50
RateLimit-Reset: 60
Attualmente non è possibile aumentare il rate limit.
Risoluzione dei problemi
Se si esegue una richiesta a un endpoint a cui la chiave API non ha accesso, si riceverà un messaggio di errore per avvisare che non si ha accesso. Se si ha bisogno di accedere a quell’endpoint, il proprietario o l’amministratore dell’azienda dovrà generare una chiave API apposita.
Documentazione API
Per tutti i dettagli sugli endpoint API disponibili, per scaricare le nostre specifiche OpenAPI e per provare gli endpoint, consultare la nostra Documentazione API.