API-sleutels aanmaken en beheren
Een sleutel voor de publieke API aanmaken, de scopes en vervaldatum kiezen, haar beperken per IP-adres en haar daarna intrekken.
Met een API-sleutel kunnen je tools de publieke API van Upsellr aanroepen namens je organisatie. Toegang tot de API is voorbehouden aan het Enterprise-abonnement.
Waar je de sleutels vindt
Open het accountmenu, daarna Manage en API & webhooks. Op een ander abonnement dan Enterprise toont het onderdeel ‘Included in the Enterprise plan’ en een knop om van abonnement te wisselen.
Een sleutel aanmaken
- Klik op Create API Key.
- Geef haar een Name die zegt waarvoor ze dient, bijvoorbeeld de naam van de tool die haar gebruikt.
- Kies een Scope preset:
- Read only: de kanalen, producten, bronnen, workflows, leden en de organisatie lezen.
- Read & Write: alles, behalve workflows starten.
- Full access: alle scopes, inclusief workflows starten.
- Custom: vink de gewenste scopes een voor een aan.
- Kies de Expiration: 7 dagen, 30 dagen, 90 dagen, 1 jaar, 3 jaar, No expiration, of een aangepaste duur van 1 tot 1.095 dagen.
- Vul zo nodig de Allowed IPs en de Allowed User-Agents in, gescheiden door komma’s.
- Klik op Create Key.
De sleutel wordt maar één keer getoond. Kopieer haar en bewaar haar op een veilige plek voordat je het venster sluit.
De beschikbare scopes
| Resource | Scopes |
|---|---|
| Kanalen | Aanmaken, lezen, wijzigen, verwijderen |
| Producten | Aanmaken, lezen, wijzigen, verwijderen |
| Bronnen | Lezen, bronbestanden uploaden |
| Workflows | Lezen, starten |
| Organisatie | De organisatie lezen, de leden lezen |
Een sleutel intrekken
Klik in de lijst op Revoke naast de sleutel. Elke integratie die haar gebruikt, werkt onmiddellijk niet meer. Deze actie is onomkeerbaar.
Goed om te weten
- Alleen eigenaren en beheerders maken sleutels aan en trekken ze in. Leden zien ze alleen-lezen.
- De lijst toont voor elke sleutel de scopes, de vervaldatum en Last used: een sleutel die nooit is gebruikt, is vaak een sleutel om in te trekken.
- Een workflow starten kan veel producten en credits inzetten. Geef de scope om te starten alleen aan integraties die hem nodig hebben.
- Maak één sleutel per integratie aan, met alleen de nodige scopes.
- Een verloren sleutel kan niet opnieuw worden getoond: trek haar in en maak een nieuwe aan.