Så här skapar eller klonar du en privat API-nyckel

Du kommer att lära dig

Lär dig hur du skapar en privat API-nyckel, som är en unik identifierare som används för API-anrop, samt hur du definierar ett scope. 

Både privata API-nyckel och scopes hjälper dig att skydda din och din kunddata genom att begränsa vad tredje part kan komma åt.

Om privata API-nyckel och kikarsikten

När du gör ett API-anrop kan en programvara ansluta till en annan. Denna anslutning gör det möjligt för en programvara att begära, redigera eller lägga till information i den andra.  

En privat API-nyckel ser till att denna begäran har rätt behörigheter (dvs. att den kommer från en behörig användare, Konto eller program). Tänk på det som en husnyckel: den släpper in dig och din familj, men utestänger alla andra.

Genom att inkludera ett scope för en privat API-nyckel läggs ytterligare ett lager av auktorisering till, vilket begränsar vilka specifika element som en tredje part kan komma åt. Scopes liknar en hotellnyckel och ger dig bara tillgång till vissa områden (som ditt rum eller gymmet) och inte till hela byggnaden. 

Typer av kikarsikten

När du skapar en privat API-nyckel måste du välja dess omfattning. Du måste med andra ord bestämma dig för om du vill att en tredje part ska göra det:

• Inte ha någon åtkomst till en API-slutpunkt.
• Visa alla data för en API-slutpunkt, men inte kunna göra ändringar (kallas även "skrivskyddad"). 
• Skapa, ta bort och göra andra ändringar i allt som är kopplat till den slutpunkten (kallas även "full åtkomst" eller "skrivåtkomst").

Du kan t.ex. lägga till prenumeranter i en lista på Klaviyo från en programvara från tredje part. I så fall måste du ha full (skriv)åtkomst till API slutpunkt för lista, profil och bulkprenumeration profil. Den tredje parten behöver dock inte tillgång till någon annan slutpunkt. 

Du kan lära dig mer om Klaviyo:s API och se tillgängliga scope för varje slutpunkt på utvecklarportalen. 

Innan du börjar

Vänligen notera följande: 

• När du har skapat en privat API-nyckel kan du inte göra det:
  • Visa den privata API-nyckel igen. 
    • Tips: Spara privata API-nyckel på ett säkert sätt och skriv ner vad du vill använda dem till, t.ex. i en lösenordshanterare. 
  • Lägg till eller redigera dess omfattning. 
    • Om du behöver ändra omfattning är det enda alternativet att ta bort den ursprungliga privata API-nyckel och sedan skapa en ny med rätt omfattning. 
• Privata API-nyckel har full åtkomst som standard.

Om du inte är säker på vilka API slutpunkt, scopes eller behörigheter du behöver, vänligen kontakta en utvecklare eller nå ut till en Klaviyo partner för att få hjälp. 

Skapa en privat API-nyckel 

1. Klicka på ditt organisationsnamn längst ned till vänster.
2. Navigera till Inställningar.
3. Klicka på API-nyckel.
   
4. Klicka på Skapa privat API-nyckel.
5. Namnge API-nyckel.
6. Välj den omfattning som du vill ge API-nyckel:
   • Skrivskyddad
   • Full
   • Anpassad
     
7. Välj Skapa.

När du nu delar en privat API-nyckel har tredje part bara tillgång till den information som du har definierat i omfattningen. 

Använda frågor 

Frågor används i avancerade scenarier. Om du inte redan är bekant med frågor eller hur de används rekommenderar vi att du samarbetar med en utvecklare. 

Inkludera

Observera att om du försöker använda include-frågan måste du ändra formatet från det som anges ovan.

Till exempel är profilens slutpunkt /API/profil.

Men om du lägger till frågeparametern include(/API/profil?include=lista), du behöver också lista:read eller lista:full access, beroende på vilken typ av API anrop du gör.

Omfattningar

Med hjälp av scopes-parametern kan du skapa en URL-parameter för att automatiskt fylla i vilken scope-åtkomst du behöver för din privata API-nyckel. 

I scopes-frågan inkluderar du en kommaseparerad lista över de scopes som du vill välja i förväg. 

Ett exempel på URL är: 
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Gå till vår utvecklarportal för att se vilka omfattningar du kan använda i denna fråga.

Klona en privat API-nyckel

Med private API-nyckel kan du genom kloning skapa en ny nyckel som har samma omfattning och behörighet som den ursprungliga nyckeln.

Observera detta:

• Kloning genererar inte samma nyckel som den ursprungliga privata API-nyckel.
• Du kan inte byta namn på en klonad API-nyckel, den har samma namn som den ursprungliga nyckeln. 

För att klona en privat API-nyckel: 

1. Navigera till fliken API-nyckel.  
2. Klicka på 3-punktsmenyn bredvid den tangent som du vill klona. 
3. Välj Clone > Clone. 
   
4. Kopiera eller ladda ner den nya privata API-nyckel och förvara den på en säker plats. 
5. Se till att ta bort din gamla nyckel om den inte längre behövs. 

Ytterligare resurser

• Se vår artikel om Komma igång med Klaviyo API.
• kassa mer utvecklare dokument.
• Läs mer om hur du håller ditt Konto säkert.