Come creare o clonare una chiave API privata
Devi essere un Proprietario o un Amministratore per creare, clonare o eliminare una chiave API privata.
Cosa imparerai
Scopri come creare una chiave API privata, che è un identificatore univoco usato per le chiamate API, e definire un ambito.
Sia le chiavi API private sia gli ambiti ti aiutano a proteggere i tuoi dati e quelli della tua clientela limitando ciò a cui le terze parti possono accedere.
Informazioni su chiavi API private e ambiti
Quando effettui una chiamata API, consenti a un software di connettersi a un altro. Questa connessione consente a un software di richiedere, modificare o aggiungere informazioni all'altro.
Una chiave API privata assicura che questa richiesta abbia le autorizzazioni corrette (ovvero che provenga da un utente, un account o un programma autorizzato). Pensalo come una chiave di casa: ti fa entrare, insieme alla tua famiglia, ma tiene fuori chiunque altro.
Includere un ambito per una chiave API privata aggiunge un ulteriore livello di autorizzazione, limitando gli elementi specifici a cui può accedere una terza parte. Gli ambiti sono simili a una chiave di un hotel, che ti dà accesso solo a determinate aree (come la tua stanza o la palestra) e non all’intero edificio.
Tipi di ambiti
Quando crei una chiave API privata, devi selezionarne l’ambito. In altre parole, devi decidere se vuoi che una terza parte possa:
- Non avere alcun accesso a un endpoint API.
- Visualizzare tutti i dati di un endpoint API, ma senza poter apportare modifiche (detto anche “sola lettura”).
- Crea, elimina e apporta altre modifiche a qualsiasi elemento associato a quell’endpoint (detto anche “accesso completo” o “accesso in scrittura”).
Ad esempio, supponiamo che tu voglia aggiungere iscritti a un elenco Klaviyo da un software di terze parti. In tal caso, devi avere accesso completo (scrittura) agli endpoint API per elenchi, profili e iscrizione in blocco dei profili. Tuttavia, la terza parte non ha bisogno di accedere ad alcun altro endpoint.
Puoi scoprire le API di Klaviyo e vedere gli ambiti disponibili per ogni endpoint sul portale di sviluppo.
Prima di iniziare
Nota quanto segue:
- Dopo aver creato una chiave API privata, non puoi:
- Visualizza di nuovo la chiave API privata.
- Suggerimento: salva in modo sicuro le chiavi API private e annota per cosa vuoi usarle, ad esempio in un gestore di password.
- Aggiungi o modifica i suoi ambiti.
- Se devi modificare gli scope, l'unica opzione è eliminare la chiave API privata originale e poi crearne una nuova con lo scope corretto.
- Visualizza di nuovo la chiave API privata.
- Le chiavi API private hanno accesso completo per impostazione predefinita.
Se non sai quali endpoint API, ambiti o autorizzazioni ti servono, contatta uno sviluppatore o rivolgiti a un partner Klaviyo per ricevere supporto.
Crea una chiave API privata
Non sarai in grado di visualizzare una chiave API privata dopo averla creata. Dovresti invece trattare le chiavi API private come una password: condividi queste chiavi solo con soggetti di cui ti fidi e salvale in un luogo sicuro, come un deposito di sicurezza o un gestore di password.
- Clicca sul nome della tua organizzazione in basso a sinistra.
- Vai su Impostazioni.
- Click chiave API.
- Clicca su Crea una chiave API privata.
- Assegna un nome alla chiave API.
- Scegli l'ambito che vuoi assegnare alla chiave API:
- Sola lettura
- Funzionalità completa
- Personalizzato
- Seleziona Crea.
Ora, quando condividi una chiave API privata, la terza parte avrà accesso solo alle informazioni che hai definito nell’ambito.
Utilizzo delle query
Le query vengono utilizzate in scenari avanzati. Se non hai già familiarità con le query o con il loro utilizzo, ti consigliamo di lavorare con uno sviluppatore.
Includi
Tieni presente che, se provi a utilizzare la query include, dovrai cambiare il formato rispetto a quanto elencato sopra.
Ad esempio, l'endpoint dei profili è /api/profiles.
Tuttavia, se aggiungi il parametro di query include (/api/profiles?include=list), ti servirà anche list:read o list:full access, a seconda del tipo di chiamata API che stai effettuando.
Ambiti
Utilizzando il parametro scopes, puoi creare un parametro URL per compilare automaticamente l’ambito di accesso necessario per la tua chiave API privata.
Nella query degli ambiti, includi un elenco separato da virgole degli ambiti che vuoi preselezionare.
Un URL di esempio è:
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write
Vai al nostro portale di sviluppo per vedere gli ambiti che puoi usare in questa query.
Clona una chiave API privata
Con le chiavi API private, la clonazione ti consente di creare una nuova chiave con gli stessi ambiti e permessi della chiave originale.
Nota:
- La clonazione non genera la stessa chiave della chiave API privata originale.
- Non puoi rinominare una chiave API clonata; ha lo stesso nome della chiave originale.
Per clonare una chiave API privata:
- Vai alla scheda chiave API .
- Clicca sul menu con i 3 puntini accanto alla chiave che vuoi clonare.
- Seleziona Clona > Clona.
- Copia o scarica la nuova chiave API privata e conservala in un luogo sicuro.
- Assicurati di eliminare la tua vecchia chiave se non è più necessaria.
Risorse aggiuntive
- Getting started with Klaviyo APIs
Get a foundational understanding of API calls and how the Klaviyo APIs can benefit your business. In this guide, you will learn about REST APIs, HTTP methods, and developer tools to prepare you for testing Klaviyo's APIs. Your first API calls can be accomplished in as little as 10 minutes from start to finish. If you are already familiar with API calls and are ready to test our APIs, follow our guide on how to use our Postman collections.
- How to keep your account secure
Learn how to make sure your Klaviyo account and data are as secure as possible.
- developer docs