Een privé-API-sleutel maken of klonen

Wat je leert

Lees hoe je een privé API-sleutel maakt, die een unieke identifier is die wordt gebruikt voor API-calls, en hoe je een scope definieert.

Zowel privé-API-sleutels als scopes helpen je om jouw en je klanten hun gegevens te beschermen door te beperken waar derden toegang toe hebben.

Over privé-API-sleutels en scopes

Wanneer je een API-aanroep doet, kan de ene software verbinding maken met de andere. Met deze verbinding kan de ene software informatie opvragen, bewerken of toevoegen aan de andere. 

Een privé API-sleutel zorgt ervoor dat deze aanvraag de juiste machtigingen heeft (d.w.z. dat deze afkomstig is van een geautoriseerde gebruiker, account of programma). Zie het als een huissleutel: die laat jou en je gezin binnen, maar houdt iedereen anders buiten.

Als je een scope toevoegt aan een privé-API-sleutel, voeg je een extra autorisatielaag toe, waarmee je beperkt tot welke specifieke onderdelen een derde partij toegang heeft. Scopes zijn vergelijkbaar met een hotelsleutel: je krijgt alleen toegang tot bepaalde ruimtes (zoals je kamer of de sportschool) en niet tot het hele gebouw.

Soorten scopes

Wanneer je een privé-API-sleutel maakt, moet je het bereik selecteren. Met andere woorden: je moet beslissen of je wilt dat een derde partij:

• Geen toegang hebben tot een API-eindpunt.
• Alle gegevens voor een API-eindpunt bekijken, maar geen wijzigingen kunnen aanbrengen (ook wel 'alleen-lezen' genoemd).
• Maak, verwijder en breng andere wijzigingen aan in alles wat bij dat eindpunt hoort (ook wel 'volledige toegang' of 'schrijftoegang' genoemd).

Stel bijvoorbeeld dat je abonnees aan een Klaviyo-lijst wilt toevoegen vanuit software van derden. In dat geval moet je volledige (schrijf)toegang hebben tot de API-eindpunten voor lijsten, profielen en profielen in bulk aanmelden. De derde partij heeft echter geen toegang nodig tot een ander eindpunt.

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

Voordat je van start gaat

Let op het volgende:

• Nadat je een private API-sleutel hebt gemaakt, kun je niet:
  • Bekijk de privé-API-sleutel opnieuw.
    • Tip: sla privé-API-sleutels veilig op en noteer waarvoor je ze wilt gebruiken, bijvoorbeeld in een wachtwoordmanager.
  • Voeg de scopes toe of bewerk ze.
    • Als je scopes moet wijzigen, is de enige optie om de oorspronkelijke privé-API-sleutel te verwijderen en vervolgens een nieuwe te maken met de juiste scope.
• Privé API-sleutels hebben standaard volledige toegang.

Als je niet zeker weet welke API-eindpunten, scopes of rechten je nodig hebt, neem dan contact op met een developer of vraag een Klaviyo-partner om hulp.

Een privé-API-sleutel maken

1. Klik linksonder op de naam van je organisatie.
2. Ga naar Instellingen.
3. Click API-sleutel.
   

4. Klik op Privé-API-sleutel maken.
5. Geef de API-sleutel een naam.
6. Kies het bereik dat je aan de API-sleutel wilt geven:
   • Alleen-lezen
   • Volledig
   • Aangepast

7. Selecteer Maken.

Wanneer je nu een privé API-sleutel deelt, heeft de externe partij alleen toegang tot de informatie die je in de scope hebt gedefinieerd.

Query's gebruiken

Queries worden gebruikt in geavanceerde scenario's. Als je nog niet bekend bent met queries of hoe je ze gebruikt, raden we aan om met een developer samen te werken.

Opnemen

Let op: als je de query include probeert te gebruiken, moet je de indeling aanpassen ten opzichte van wat hierboven staat.

Het profiel-eindpunt is bijvoorbeeld /api/profiles.

Als je echter de include-queryparameter toevoegt (/api/profiles?include=list), heb je ook list:read of list:full access nodig, afhankelijk van het type API-call dat je doet.

Bereiken

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

Neem in de scopes-query een door komma's gescheiden lijst op met de scopes die je vooraf wilt selecteren.

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 je in deze query kunt gebruiken.

Een privé-API-sleutel klonen

Met private API-sleutels kun je door te klonen een nieuwe API-sleutel maken met dezelfde scopes en machtigingen als de oorspronkelijke sleutel.

Let op:

• Klonen genereert niet dezelfde sleutel als de oorspronkelijke persoonlijke API-sleutel.
• Je kunt de naam van een gekloonde API-sleutel niet wijzigen; deze heeft dezelfde naam als de oorspronkelijke sleutel.

Zo kloon je een privé-API-sleutel:

1. Ga naar het tabblad API-sleutels .
2. Klik op het menu met 3 puntjes naast de sleutel die je wilt klonen.
3. Selecteer Klonen > Klonen.
   

4. Kopieer of download de nieuwe private API-sleutel en sla deze op een veilige plek op.
5. Zorg ervoor dat je je oude sleutel verwijdert als die niet meer nodig is.

Extra hulpbronnen