Hoe een privé API-sleutel maken of klonen

Wat je leert

Leer hoe je een private API-sleutel aanmaakt, wat een unieke identificatie is die wordt gebruikt voor API oproepen, en hoe je een scope definieert. 

Zowel private API-sleutel als scopes helpen je om jouw klantgegevens te beschermen door te beperken waar derden toegang toe hebben.

Over privé API-sleutel en scopes

Als je een API-aanroep doet, kun je de ene software met de andere verbinden. Met deze verbinding kan een software informatie opvragen, bewerken of toevoegen aan de ander.  

Een privé API-sleutel zorgt ervoor dat dit verzoek de juiste permissies heeft (dus dat het afkomstig is van een geautoriseerde gebruiker, account, of programma). Zie het als een huissleutel: hij laat jou en je familie binnen, maar houdt alle anderen buiten.

Het opnemen van een scope voor een private API-sleutel voegt een extra autorisatielaag toe, die beperkt tot welk specifiek element een derde partij toegang heeft. Scopes zijn vergelijkbaar met een hotelsleutel, die je alleen toegang geeft tot bepaalde gebieden (zoals je kamer of de sportschool) en niet tot het hele gebouw. 

Soorten scopes

Als je een private API-sleutel aanmaakt, moet je de reikwijdte ervan selecteren. Met andere woorden, je moet beslissen of je wilt dat een derde partij dit doet:

• Geen toegang hebben tot een API eindpunt.
• Alle gegevens voor een API eindpunt bekijken, maar geen wijzigingen kunnen aanbrengen (ook wel "alleen-lezen" genoemd). 
• Maken, verwijderen en andere wijzigingen aanbrengen aan alles wat gekoppeld is aan dat eindpunt (ook wel "volledige toegang" of "schrijftoegang" genoemd).

Stel bijvoorbeeld dat je abonnee wilt toevoegen aan een Klaviyo lijst van software van derden. In dat geval moet je volledige (schrijf)toegang hebben tot het API eindpunt voor lijst, profiel en bulk subscribing profiel. De derde partij hoeft echter geen toegang te hebben tot een ander eindpunt. 

Je kunt meer te weten komen over Klaviyo's API en de beschikbare scopes voor elk eindpunt bekijken op het ontwikkelaarsportaal. 

Voordat je van start gaat

Let op het volgende: 

• Nadat je een privé API-sleutel hebt gemaakt, kun je deze niet meer gebruiken:
  • Bekijk de privé API-sleutel opnieuw. 
    • Tip: sla privé API-sleutel veilig op en noteer waarvoor je ze wilt gebruiken, bijvoorbeeld in een wachtwoordmanager. 
  • De scopes toevoegen of bewerken. 
    • Als je de scopes moet veranderen, is de enige optie om de oorspronkelijke private API-sleutel te verwijderen en dan een nieuwe aan te maken met de juiste scope. 
• Privé API-sleutel hebben standaard volledige toegang.

Als je niet zeker weet welk API eindpunt, scopes of rechten je nodig hebt, neem dan contactpersoon een ontwikkelaar of bereik een Klaviyo partner voor hulp. 

Maak een privé API-sleutel 

1. Klik linksonder op de naam van je organisatie.
2. Navigeer naar Instellingen.
3. Klik op API-sleutel.
   
4. Klik op Maak privé API-sleutel.
5. Geef de API-sleutel een naam.
6. Kies het bereik dat je de API-sleutel wilt geven:
   • Alleen-lezen
   • Volledig
   • Aangepast
     
7. Selecteer Maken.

Als je nu een privé API-sleutel deelt, heeft de derde partij alleen toegang tot de informatie die je in het bereik hebt gedefinieerd. 

Query's gebruiken 

Query's worden gebruikt in geavanceerde scenario's. Als je nog niet bekend bent met query's of hoe je ze moet gebruiken, raden we je aan om samen te werken met een ontwikkelaar. 

Opnemen

Merk op dat als je de include query probeert te gebruiken, je het formaat moet veranderen ten opzichte van wat hierboven staat.

Het profiel eindpunt is bijvoorbeeld /API/profiel.

Als je echter de include queryparameter(/API/profiel?include=lijst) toevoegt, heb je ook lijst:read of lijst:full toegang nodig, afhankelijk van welk type API je aanroept.

Bereiken

Met de scopes parameter kun je een URL parameter maken om automatisch in te vullen welke scope toegang je nodig hebt voor je privé API-sleutel. 

Neem in de scopes query een door komma's gescheiden lijst op van de scopes die je wilt voorselecteren. 

Een voorbeeld-URL is: 
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Ga naar ons ontwikkelaarsportaal om de scopes te bekijken die u in deze query kunt gebruiken.

Een privé API-sleutel klonen

Met private API-sleutel kun je met klonen een nieuwe sleutel maken die dezelfde scopes en rechten heeft als de originele sleutel.

Merk op dat:

• Klonen genereert niet dezelfde sleutel als de originele privésleutel API-sleutel.
• Je kunt een klonen API-sleutel niet hernoemen; deze heeft dezelfde naam als de oorspronkelijke sleutel. 

Een privé API-sleutel klonen: 

1. Navigeer naar het tabblad API-sleutel.  
2. Klik op het 3-stippenmenu naast de toets die je wilt klonen. 
3. Selecteer klonen > klonen. 
   
4. Kopieer of download de nieuwe privésleutel APIen zet hem op een veilige plek. 
5. Zorg ervoor dat je je oude sleutel verwijdert als je hem niet meer nodig hebt. 

Extra hulpbronnen

• Zie ons artikel over Aan de slag met Klaviyo API.
• afrekenen meer ontwikkelaarsdocumenten.
• Meer informatie over het beveiligen van je account.