Så 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, och hur du definierar ett omfång.

Både privata API-nycklar och omfång hjälper dig att skydda dina och dina kunders data genom att begränsa vad tredje parter kan komma åt.

Om privata API-nycklar och omfattningar

När du gör ett API-anrop gör det att en programvara kan ansluta till en annan. Den här anslutningen gör att en programvara kan begära, redigera eller lägga till information i den andra. 

En privat API-nyckel säkerställer att den här begäran har rätt behörigheter (dvs. att den kom från en auktoriserad användare, ett Konto eller ett program). Tänk på den som en husnyckel: den släpper in dig och din familj, men stänger ute alla andra.

Att inkludera ett scope för en privat API-nyckel lägger till ytterligare ett auktoriseringslager och begränsar vilka specifika delar en tredje part kan komma åt. Scopes liknar en hotellnyckel och ger dig bara åtkomst till vissa områden (som ditt rum eller gymmet) och inte hela byggnaden.

Typer av omfattningar

När du skapar en privat API-nyckel måste du välja dess omfattning. Med andra ord måste du bestämma om du vill att en tredje part ska:

• 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 associerat med den slutpunkten (kallas även ”fullständig åtkomst” eller ”skrivåtkomst”).

Till exempel kan du vilja lägga till prenumeranter i en Klaviyo-lista från programvara från tredje part. I så fall måste du ha fullständig (skriv-)åtkomst till API-slutpunkter för listor, profiler och massprenumeration av profiler. Tredje parten behöver dock inte åtkomst till någon annan slutpunkt.

Du kan läsa mer om Klaviyos API och se tillgängliga scopes för varje slutpunkt i utvecklarportalen.

Innan du börjar

Observera följande:

• När du har skapat en privat API-nyckel kan du inte:
  • Visa den privata API-nyckeln igen.
    • Tips: spara privata API-nycklar säkert och skriv ned vad du vill använda dem till, till exempel i en lösenordshanterare.
  • Lägg till eller redigera dess omfattningar.
    • Om du behöver ändra omfång är det enda alternativet att ta bort den ursprungliga privata API-nyckeln och sedan skapa en ny med rätt omfång.
• Privata API-nycklar har full åtkomst som standard.

Om du inte är säker på vilka API-slutpunkter, omfång eller behörigheter du behöver kan du kontakta en utvecklare eller höra av dig 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. Gå till Inställningar.
3. Click API-nyckel.
   

4. Klicka på Skapa privat API-nyckel.
5. Namnge API-nyckeln.
6. Välj det omfång som du vill ge API-nyckeln:
   • Skrivskyddad
   • Full
   • Anpassad

7. Välj Skapa.

När du delar en privat API-nyckel har tredje parten endast åtkomst till den information som du definierade i omfattningen.

Använda frågor

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

Inkludera

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

Till exempel är profil-slutpunkten /api/profiles.

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

Omfattningar

Med parametern scopes kan du skapa en URL-parameter för att automatiskt fylla i vilken åtkomstomfattning du behöver för din privata API-nyckel.

Inkludera en kommaavgränsad lista över de scopes som du vill förvälja i scopes-frågan.

Ett exempel på en 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 den här frågan.

Klona en privat API-nyckel

Med privata API-nycklar kan du genom kloning skapa en ny nyckel som har samma omfång och behörigheter som originalnyckeln.

Observera att:

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

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

1. Navigera till fliken API-nycklar .
2. Klicka på menyn med tre punkter bredvid nyckeln som du vill klona.
3. Välj Klona > Klona.
   

4. Kopiera eller ladda ner den nya privata API-nyckeln och spara den på en säker plats.
5. Se till att radera din gamla nyckel om den inte längre behövs.

Ytterligare resurser