Met een API-sleutel praat je eigen software via de REST API met je platform, bijvoorbeeld om leden op te vragen, iemand voor een cursus in te schrijven of een WordPress-site te koppelen. Elke sleutel is een geheim wachtwoord voor een programma. Je bepaalt dus per sleutel wat die mag, en je kunt hem op elk moment vervangen of verwijderen.
Wie API-sleutels kan beheren
API staat in het blok Integraties en API van het instellingenmenu. Je rol heeft naast Platforminstellingen bijwerken ook API-sleutels beheren nodig. Dit recht is nooit beschikbaar voor een aangepaste rol, dus alleen de ingebouwde rollen Eigenaar en Beheerder kunnen hier werken. Hetzelfde recht geeft ook toegang tot OAuth-apps en Single sign-on.
API-toegang hangt af van je pakket. Zit die er niet in, dan toont de pagina “API-toegang is inbegrepen in elk betaald pakket. Upgrade om API-sleutels aan te maken.” samen met Pakket wijzigen, en blijft Nieuwe API-sleutel uitgeschakeld. Bestaande sleutels worden door de API geweigerd tot je pakket de API-toegang weer bevat.
Een sleutel aanmaken
Klik op Nieuwe API-sleutel. Het venster API-sleutel aanmaken opent.
- Vul een Sleutelnaam in waaraan je later ziet wie de sleutel gebruikt, bijvoorbeeld de tool of de website waar hij bij hoort. De naam is verplicht.
- Bepaal wat de sleutel mag. Een nieuwe sleutel begint met volledige toegang, dus alle rechten zijn geselecteerd.
- Klik op Aanmaken.
Wil je de sleutel beperken, klik dan op Beperken tot specifieke rechten. Alle rechten worden dan gewist en je kiest de rechten die je nodig hebt. De rechten zijn per onderdeel gegroepeerd, zoals Leden, Groepen, Cursussen of Betalingen, en elk onderdeel noemt acties als Bekijken of Beheren met een korte beschrijving. Met Alles selecteren en Alles deselecteren zet je een heel onderdeel in één keer aan of uit. Een teller laat zien hoeveel rechten de sleutel heeft. Een sleutel heeft minstens één recht nodig, en Volledige toegang herstellen selecteert ze weer allemaal.
Nadat je op Aanmaken hebt geklikt, toont het venster Je nieuwe API-sleutel de volledige sleutel één keer. Kopieer hem en bewaar hem op een veilige plek. Daarna toont de lijst alleen de laatste vier tekens, en niemand kan de volledige sleutel opnieuw weergeven.
Een sleutel gebruiken
Het vak API-documentatie boven de lijst toont de Basis-URL van de API met een kopieerknop, en Documentatie openen brengt je naar de interactieve naslag met alle endpoints.
Stuur de sleutel mee met elk verzoek, als Bearer token in de header
Authorization of in de header X-Api-Key. Sleutels beginnen met mak_. Een
verzoek waarvoor de sleutel een recht mist, wordt geweigerd.
Een sleutel hoort bij het teamlid dat hem heeft aangemaakt. Hoort die persoon niet meer bij je werkruimte, dan werkt de sleutel niet meer. Maak sleutels voor koppelingen die lang moeten blijven draaien daarom aan met een account dat blijft.
De lijst toont elke sleutel met Naam, Sleutel, Laatst gebruikt en Aangemaakt. Laatst gebruikt wordt hooguit één keer per minuut bijgewerkt. Dat is genoeg om te zien of een sleutel nog in gebruik is.
Een sleutel wijzigen, roteren en verwijderen
Klik op een sleutel in de lijst, of gebruik Bewerken, het potloodpictogram in de rij, om de naam of de rechten te wijzigen. Wijzigingen gaan in met Opslaan.
Is een sleutel misschien gelekt, roteer hem dan. Sleutel roteren in hetzelfde venster vraagt: “Deze sleutel roteren? Het oude geheim werkt direct niet meer en externe integraties hebben het nieuwe nodig.” Na je bevestiging verschijnt de nieuwe sleutel één keer in Je nieuwe API-sleutel. Naam en rechten blijven hetzelfde, en Laatst gebruikt begint opnieuw. Vul de nieuwe sleutel in bij elke tool die de oude gebruikte.
Wil je een sleutel verwijderen, gebruik dan Verwijderen, het prullenbakpictogram in de rij, of Verwijderen in het geopende venster, en bevestig. Elke tool die de sleutel nog gebruikt, wordt vanaf dat moment geweigerd.
OAuth-apps, single sign-on en webhooks
Een sleutel plakken is niet de enige manier om te koppelen:
- Met OAuth-apps koppelen andere MemberAreas je software via OAuth in plaats van met een geplakte API-sleutel.
- Single sign-on logt leden in vanuit een ander systeem. Dat staat beschreven in Inloggen, registratie en SSO.
- Webhooks voor gebeurtenissen rond leden en betalingen hebben een eigen pagina onder Instellingen > Webhooks, die verschijnt zodra Betalingen aanstaat.