Come creare o clonare una chiave API privata

Imparerai

Scopri come creare una chiave API privata, che è un identificatore unico utilizzato per le chiamate API, e come definire un ambito. 

Sia la chiave privata API che gli ambiti ti aiutano a proteggere i tuoi dati e quelli dei tuoi clienti limitando l'accesso di terzi.

Informazioni sulla chiave privata API e sui cannocchiali

Quando si effettua una chiamata API, si permette a un software di connettersi a un altro. Questa connessione permette a un software di richiedere, modificare o aggiungere informazioni all'altro.  

Una chiave API privata assicura che la richiesta abbia i giusti permessi (cioè che provenga da un utente, un account o un programma autorizzato). Considerala come una chiave di casa: permette a te e alla tua famiglia di entrare, ma tiene fuori tutti gli altri.

L'inclusione di un ambito per una chiave privata API aggiunge un ulteriore livello di autorizzazione, limitando gli elementi specifici a cui una terza parte può accedere. Gli Scope sono simili alle chiavi di un hotel e ti permettono di accedere solo a determinate aree (come la tua stanza o la palestra) e non all'intero edificio. 

Tipi di cannocchiali

Quando crei una chiave API privata, devi selezionarne l'ambito. In altre parole, devi decidere se vuoi che una terza parte lo faccia:

• Non ha accesso a un endpoint API.
• Visualizzare tutti i dati di un endpoint API, ma non poter apportare modifiche (chiamato anche "sola lettura"). 
• Creare, cancellare e apportare altre modifiche a qualsiasi cosa associata a quell'endpoint (chiamato anche "accesso completo" o "accesso in scrittura").

Ad esempio, supponiamo che tu voglia aggiungere l'iscritto a un elenco di Klaviyo da un software di terze parti. In questo caso, devi avere accesso completo (in scrittura) all'endpoint API per elenco, profilo e per la sottoscrizione massiva di profilo. Tuttavia, la terza parte non ha bisogno di accedere a nessun altro endpoint. 

Puoi conoscere le API diKlaviyo e vedere gli ambiti disponibili per ogni endpoint sul portale di sviluppo. 

Prima di iniziare

Tieni presente quanto segue: 

• Dopo aver creato una chiave API privata, non potrai più farlo:
  • Visualizza nuovamente la chiave API privata. 
    • Suggerimento: salva in modo sicuro le chiavi private API e annota per cosa vuoi usarle, ad esempio in un gestore di password. 
  • Aggiungi o modifica i suoi ambiti. 
    • Se devi cambiare ambito, l'unica possibilità è cancellare la chiave API privata originale e crearne una nuova con l'ambito corretto. 
• La chiave privata API ha accesso completo per impostazione predefinita.

Se non sei sicuro dell'endpoint, degli ambiti o dei permessi di API di cui hai bisogno, contatta uno sviluppatore o rivolgiti a Klaviyo partner per ricevere aiuto. 

Creare una chiave API privata 

1. Fai clic sul nome della tua organizzazione in basso a sinistra.
2. Vada su Impostazioni.
3. Clicchi sulle chiavi API.
   
4. Clicchi su Crea chiave API privata.
5. Dare un nome alla chiave API.
6. Scelga l'ambito che desidera assegnare alla chiave API:
   • In sola lettura
   • Completo
   • Personalizzato
     
7. Selezionare Crea.

Ora, quando condivide una chiave API privata, la terza parte avrà accesso solo alle informazioni che lei ha definito nell'ambito. 

Utilizzo delle query 

Le query sono utilizzate in scenari avanzati. Se non hai già familiarità con le query o con il loro utilizzo, ti consigliamo di rivolgerti a uno sviluppatore. 

Includere

Si noti che se cerca di utilizzare la query include, dovrà cambiare il formato rispetto a quello elencato sopra.

Ad esempio, l'endpoint dei profili è /api/profili.

Tuttavia, se si aggiunge il parametro di query include(/api/profiles?include=list), avrà anche bisogno dell'accesso list:read o list:full, a seconda del tipo di chiamata API che sta effettuando.

Scopi

Utilizzando il parametro Scopes, può creare un parametro URL per compilare automaticamente l'accesso all'ambito di cui ha bisogno per la sua chiave API privata. 

Nella query degli ambiti, includi un elenco separato da virgole degli ambiti che vuoi preselezionare. 

Un esempio di URL è: 
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Clona una chiave API privata

Con le chiavi API private, la clonazione consente di creare una nuova chiave che ha gli stessi ambiti e permessi della chiave originale.

Si noti che:

• La clonazione non genera la stessa chiave della chiave API privata originale.
• Non può rinominare una chiave API clonata; ha lo stesso nome della chiave originale. 

Per clonare una chiave API privata: 

1. Si rechi nella scheda Chiavi API . 
2. Clicchi sul menu a 3 punti accanto al tasto che desidera clonare. 
3. Selezioni Clone > Clone. 
   
4. Copia o scarica la nuova chiave privata API e conservala in un luogo sicuro. 
5. Assicurati di cancellare la vecchia chiave se non è più necessaria. 

Risorse aggiuntive

• Consulti il nostro articolo su come iniziare a utilizzare le API di Klaviyo.
• Consulti altri documenti per gli sviluppatori.
• Per saperne di più sulla sicurezza del suo conto.