API-sleutels

In de sectie API-sleutels van Instellingen (/settings/api-keys) maak je de sleutels aan waarmee je storefront de API van dit bedrijf gebruikt. Sleutels zijn gekoppeld aan het momenteel geselecteerde bedrijf, dus wissel eerst naar het juiste bedrijf voordat je er een aanmaakt. Elk ingelogd teamlid kan sleutels aanmaken en intrekken.

Hoe een storefront de sleutel daadwerkelijk gebruikt (headers, scopes, fouten) lees je bij Authenticatie in de API-referentie. De sectie linkt ook naar de volledige API-documentatie in een nieuw tabblad.

Een sleutel aanmaken#

1. Open Instellingen en kies API-sleutels.
2. Vul in het vak Sleutel aanmaken een Sleutelnaam in (bijvoorbeeld storefront).
3. Zet minstens één scope-pil aan. De knop Aanmaken blijft uitgeschakeld totdat je zowel een naam als een scope hebt; een hint ernaast vertelt je wat er nog ontbreekt.
4. Klik op Aanmaken.

Scopes#

Scopes komen van je ingeschakelde modules, dus de lijst verschilt per bedrijf. Je ziet altijd tenant:read, plus een read- en write-scope voor elke ingeschakelde module, bijvoorbeeld commerce:read en commerce:write. Vraag de platformbeheerder om een module in te schakelen als de scope die je nodig hebt niet in de lijst staat.

Kies de smalste set die werkt: een storefront die alleen producten toont heeft read-scopes nodig, geen write-scopes.

Kopieer het token: het wordt maar één keer getoond#

Direct na het aanmaken verschijnt het platte token van de sleutel in een uitgelicht vak met de titel Kopieer dit token nu. Wordt maar één keer getoond. Dit is het enige moment waarop je het kunt zien:

• Klik op Token kopiëren (het label verandert kort in Gekopieerd) en bewaar het token in de geheime opslag van je storefront.
• Zodra je de pagina verlaat of ververst, is het token nooit meer zichtbaar.
• Ben je het kwijt, dan is er geen herstel mogelijk: trek de sleutel in en maak een nieuwe aan.

Je sleutels bekijken#

Elke sleutelrij toont de naam, de lijst met scopes, wanneer de sleutel is aangemaakt, en Laatst gebruikt met een datum, of Nooit gebruikt als er nog niets mee is opgevraagd. Nooit gebruikt op een oude sleutel is een goed signaal dat je die kunt intrekken.

Een sleutel intrekken#

1. Klik op Intrekken in de rij van de sleutel.
2. Een dialoog Sleutel intrekken vraagt om bevestiging: storefronts die deze sleutel gebruiken verliezen direct API-toegang.
3. Klik op Intrekken om te bevestigen.

Intrekken is direct en definitief. Gebruikt een live storefront de sleutel nog, maak dan eerst een vervangende sleutel aan, zet die live en trek daarna pas de oude in.