Skip to main content
Whop heeft vijf soorten inloggegevens. Welke je nodig hebt, hangt af van wiens data je benadert en waar de code draait. Kies uit deze tabel en beperk daarna de scope van de inloggegevens voordat ze in de buurt van productie komen.

API-sleutels

Een Account API-sleutel authenticeert je server als één account. Een App API-sleutel authenticeert je app bij elk account dat de app heeft geïnstalleerd. Beide zijn geheim: houd ze server-side.

Een Account API-sleutel aanmaken

Gebruik een Account API-sleutel wanneer je server optreedt namens je eigen account en de subaccounts daarvan. Open op de Developer-pagina van het dashboard Account API Keys en selecteer Create. De Quickstart loopt dit stap voor stap door in de sandbox.

Een App API-sleutel aanmaken

Gebruik een App API-sleutel wanneer je een app bouwt en toegang nodig hebt tot data van de accounts die de app hebben geïnstalleerd.
  1. Open Apps in het dashboard.
  2. Selecteer Create app en geef je app een naam. Je kunt de naam later wijzigen.
  3. Je sleutel is de verborgen waarde na WHOP_API_KEY in de sectie Environment variables. Gebruik de knop om hem zichtbaar te maken en bewaar hem op een veilige plek.

Gebruikerstokens met accountscope

Een gebruikerstoken met accountscope treedt op als één specifieke gebruiker binnen één specifiek account. Je server maakt het aan met je API-sleutel en geeft het door aan je client, zodat je gebruikers Whop bereiken zonder zich ooit bij Whop aan te melden. Maak er een aan met POST /api/v1/access_tokens en geef account_id, user_id en de acties die je wilt toestaan mee:
account_id begint met biz_ en user_id begint met user_. Je API-sleutel moet toestemming hebben om beide te benaderen. Tokens verlopen standaard na één uur. Stel expires_at in om dat te wijzigen, tot een maximum van drie uur. Maak ze aan wanneer je ze nodig hebt in plaats van ze te cachen.

De scope van een token beperken

scoped_actions is de lijst met dingen die het token mag doen. Elk item is een actiestring met dubbele punten als scheidingsteken.
Laat je scoped_actions leeg of weg, dan erft het token alle permissies van de inloggegevens waarmee het is aangemaakt. Een token dat aan een browser wordt gegeven, heeft dan het volledige bereik van je API-sleutel. Geef altijd een expliciete lijst mee.
Een actie moet een subset zijn van de permissies van de inloggegevens waarmee het token wordt aangemaakt. Je kunt niets toekennen wat je API-sleutel zelf niet heeft. Deze acties komen momenteel voor in de gidsen van Whop: De API publiceert geen vaste lijst, dus beschouw dit als de gedocumenteerde set en niet als de volledige set. De doorslaggevende grens zijn altijd de permissies van de inloggegevens waarmee het token wordt aangemaakt.

Accounttoegangstokens

Een accounttoegangstoken treedt op als het account zelf, zonder gekoppelde gebruiker. Maak er een aan met POST /api/v1/access_tokens en geef alleen account_id en de toe te staan scoped_actions mee. Het verloopt volgens hetzelfde schema als een gebruikerstoken met accountscope. Gebruik het wanneer een client korte tijd de toegang van je account nodig heeft, zoals een ingesloten component, en er geen specifieke gebruiker bij betrokken is. Endpoints die optreden als een gebruiker, zoals endpoints voor meldingen of voorkeuren, weigeren het.

iframe-gebruikerstokens

Wanneer je app binnen Whop wordt weergegeven, bevat elk same-origin-request een kortlevende JWT in de header x-whop-user-token. Je verifieert de handtekening om te weten wie de aanvraag doet en controleert daarna wat die persoon mag zien. De Python- en Ruby-SDK’s bevatten hiervoor een helper. De TypeScript-SDK niet, dus verifieer de JWT daar zelf. Dit token maak je nooit zelf aan. Whop verstuurt het en jij valideert het. Zie Authenticatie.

OAuth-tokens

Een OAuth-token vertegenwoordigt een gebruiker die zich bij Whop heeft aangemeld en je app heeft goedgekeurd voor een reeks scopes. Anders dan bij een API-sleutel is het bereik beperkt tot wat die individuele gebruiker kan doen. Gebruik het voor Sign in with Whop en om namens een gebruiker acties uit te voeren op diens eigen account. Zie OAuth.

Checklist voor scopes

Voordat inloggegevens in productie komen:
  • Geef bij elk aangemaakt token expliciete scoped_actions mee. Vertrouw nooit op overerving.
  • Geef API-sleutels een aangepaste set permissies zodra je weet welke endpoints je aanroept, in plaats van ze op Admin te laten staan.
  • Houd API-sleutels server-side. Alleen gebruikerstokens horen in een client.
  • Maak kortlevende tokens aan wanneer je ze nodig hebt in plaats van langlevende tokens te cachen.
  • Gebruik aparte inloggegevens per omgeving en controleer welke je gebruikt voordat je iets uitvoert waarbij geld wordt verplaatst.

Volgende stappen

Quickstart

Maak een sandboxsleutel aan en doe je eerste aanroep.

Kernconcepten

Hoe accounts, gebruikers en permissies met elkaar samenhangen.

OAuth

De volledige OAuth 2.1- en PKCE-flow.

Testen in de sandbox

Probeer inloggegevens eerst uit op testdata.