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.

Autenticazione e accesso utente (chiave API)

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.

1. Scegliere una scadenza o impostare una data di inizio personalizzata e un numero di ore di scadenza della chiave.
2. Dare un nome alla chiave.
3. 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.

Endpoint dell’API

Con l’API di Kinsta è possibile eseguire le seguenti azioni:

Hosting WordPress

• Ottenere un elenco dei siti WordPress dell’azienda, dettagli su un sito specifico e dettagli sull’ambiente di un sito.
• Creare un nuovo sito WordPress, clonare un sito esistente, creare un sito vuoto senza WordPress e cancellare un sito.
• Creare un nuovo sito di staging, inviare un ambiente di staging alla versione live ed eliminare un ambiente di staging.
• Cancellare la cache di un sito, riavviare e aggiornare PHP e ottenere un elenco di indirizzi IP negati.
• Fare un elenco dei plugin e dei temi del sito e aggiornarli.
• Aggiungere o rimuovere un dominio.
• Cancellare la cache perimetrale e la cache del CDN sul sito.
• Ottenere un elenco dei backup del sito e un elenco di backup scaricabili, ripristinare ed eliminare un backup.
• Prelevare i file di log del sito.

Hosting di siti statici

• Ottenere un elenco dei siti statici dell’azienda e i dettagli di un sito specifico, aggiornare le impostazioni del sito ed eliminare un sito.
• Ottenere i dati di distribuzione di un sito statico e distribuire manualmente o programmaticamente il sito.

Hosting di applicazioni

• Ottenere un elenco delle applicazioni dell’azienda e i dati di un’applicazione specifica, compresi i dati e i processi di distribuzione, aggiornare le impostazioni dell’applicazione ed eliminare un’applicazione.
• Ottenere i dati di distribuzione di un’applicazione e distribuire manualmente o programmaticamente la propria applicazione.
• Ottenere informazioni dalle statistiche dell’applicazione.
• Creare una connessione interna tra l’applicazione e il database.
• Abilitare il CDN e l’edge caching e cancellare la cache per entrambi.

Hosting di database

• Ottenere un elenco dei database aziendali e i dati di un database specifico, creare un nuovo database, aggiornare le impostazioni del database ed eliminare un database.

Azienda

• Ottenete un elenco degli utenti dell’azienda, con l’indirizzo e-mail, il nome completo e un link alla foto del profilo.

Casi d’uso comuni

Reporting

Le API possono essere utilizzate per leggere i dati in modo da creare i propri report o integrare i servizi di Kinsta nei propri sistemi di tracciamento interni. Ad esempio, se si gestisce un’agenzia e si usa un’applicazione che elenca tutti i clienti, è possibile utilizzare l’API per fare un elenco di tutti i siti WordPress, le applicazioni e i database ospitati su Kinsta appartenenti a ciascun cliente.

Operazioni programmate

È possibile creare un’applicazione personalizzata per pianificare attività notturne che possono influire sulle prestazioni del sito o causare interruzioni. Ad esempio, cancellando la cache del sito durante la notte si possono ridurre al minimo le interruzioni per i visitatori.

Gestione del sito

Utilizzando Node.js e l’API, è possibile creare uno Slackbot che consente di risparmiare tempo e di gestire i siti in modo più efficiente. Lo Slackbot può essere utilizzato per operazioni come il controllo dello stato del sito, la cancellazione della cache e il riavvio del motore PHP.

Creazione di siti WordPress

È possibile aggiungere automaticamente un nuovo sito o una nuova installazione di WordPress utilizzando l’API. Ad esempio, se si gestisce un’agenzia e si desidera automatizzare la creazione del sito senza dover accedere ogni volta a MyKinsta, si può utilizzare l’API per creare il sito e installare WooCommerce, Yoast SEO e Easy Digital Downloads.

È possibile anche creare un’installazione WordPress Multisite (is_multisite TRUE) e configurare un’installazione con sottodominio (is_subdomain_multisite TRUE) o con sottodirectory (is_subdomain_multisite FALSE).

Per verificare lo stato di creazione del sito, occorre utilizzare l’endpoint Operations.

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 ai seguenti valori:

• 120 richieste al minuto per ID azienda identificato dalla chiave API.
• 1000 richieste al minuto per indirizzo IP. Questo vale se si ha accesso a più aziende.
• 5 richieste al minuto per la creazione di risorse, ad esempio la creazione di un sito WordPress.

Per vedere l’attuale quota limite, bisogna controllare le intestazioni RateLimit nella risposta API più recente. Al momento non è possibile aumentare la quota limite.

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.