Skip to main content
De API van Whop bestaat uit een klein aantal objecten die op voorspelbare manieren met elkaar verbonden zijn. Deze pagina definieert elk object en zegt het duidelijk wanneer een object meer dan één naam heeft.

Accounts en identiteit

biz_
Een bedrijf op Whop. Is eigenaar van API-sleutels, producten, webhooks en geld. Zie Accounts.
user_
Een persoon met een Whop-login. Een gebruiker kan bij veel accounts kopen en kan ook helpen een account te runnen. Zie Users.
Een gebruiker die toegang heeft gekregen om een account te beheren. Diens rol bepaalt wat hij kan doen. Zie Teamleden.
Een gebruiker gezien als klant: iemand die een lidmaatschap heeft of ooit had op iets wat het account verkoopt. Zie Leden.

Subaccount

Een account dat je inschrijft en namens wie je handelt wanneer je een marketplace runt. Je int betalingen namens dat account en betaalt het uit. Platformgidsen noemen dit soms een sub-merchant. Beide woorden verwijzen naar hetzelfde object. De platform-quickstart loopt de volledige flow door.
De identiteitscontrole die een account moet doorstaan voordat het uitbetalingen kan ontvangen. Particulieren doorlopen Know Your Customer-controles (KYC). Bedrijven doorlopen Know Your Business-controles (KYB). Zie Verificaties.
idpf_
Het record met geverifieerde identiteitsgegevens dat een verificatie oplevert.

Wat je verkoopt

Een account verkoopt producten. Een product heeft een of meer varianten, die de prijs bepalen, en is gekoppeld aan de experiences die een koper daadwerkelijk krijgt.
prod_
Iets wat een account verkoopt. Bevat de beschrijving, de media en de varianten waaruit een koper kan kiezen. Zie Producten.
plan_
Eén koopbare configuratie van een product, met een eigen prijs, factureringsvorm, voorraad, SKU en kenmerken. Variant-ID’s behouden de prefix plan_. Zie Varianten.
mem_
Wat een koper krijgt wanneer hij betaalt. Koppelt een gebruiker aan een variant en heeft een status die aangeeft of de toegang op dit moment geldig is. Zie Lidmaatschappen.

Experience

Een eenheid van content of functionaliteit binnen wat een account verkoopt. Een product is gekoppeld aan een of meer experiences, en een lidmaatschap op dat product geeft toegang tot die experiences. Dit is het meest platformspecifieke begrip van Whop, en het enige dat je niet uit de naam kunt afleiden. Als je een app bouwt die binnen Whop draait, is de experience de plek waarin je app wordt weergegeven. Zie App-weergaven.

Entitlement

Het record dat zegt dat een gebruiker op dit moment een specifiek iets mag gebruiken. Toegang is de vraag, en de entitlement is het opgeslagen antwoord. Controleer deze voor een account, een product of een experience. Zie Authenticatie.

Hoe geld beweegt

Geld komt binnen, staat ergens en gaat daarna weer weg. Elk object hieronder is één stap op dat pad, in de volgorde waarin het gebeurt.
ch_
De herbruikbare definitie van een aankoop: welke variant, tegen welke prijs en met welke doorverwijzing. Levert een live checkoutpagina op. Zie Checkoutconfiguraties.
pay_
Eén poging om geld van een koper naar een account te verplaatsen, met een status die aangeeft of het is gelukt.
Dezelfde gebeurtenis, beschreven vanuit het perspectief van het kaartnetwerk. De docs gebruiken beide woorden. Het API-object is de payment.

Ledger

Het doorlopende overzicht van elke creditering en debitering op het geld van een account. Het is de bron van waarheid voor wat een account bezit en wat het tegoed heeft. Geld komt in een ledger terecht voordat het ergens anders naartoe gaat. Zie Ledger-activiteit.
Het bedrag dat op dit moment op een ledger staat en dat je kunt uitgeven of opnemen.
Een deel van een saldo dat Whop achterhoudt voor toekomstige terugbetalingen en geschillen. Het wordt volgens een schema vrijgegeven.
Het aandeel van Whop in een betaling, ingehouden voordat het geld een saldo bereikt.
Geld dat van buiten Whop aan een saldo wordt toegevoegd. Zie Stortingen.
Geld dat een saldo verlaat naar een bankrekening of wallet buiten Whop. Zie Uitbetalingen.
Geld dat binnen Whop tussen twee accounts wordt verplaatst, zonder de buitenwereld te raken. Zie Overboekingen.
Een omzetting van een saldo tussen ondersteunde tokens, chains of walletbestemmingen. Zie Swaps.
icrd_
Een virtuele kaart, uitgegeven door Whop, die uitgeeft vanuit het saldo van een account of gebruiker. Zie Kaarten.
Een voltooide betaling die op jouw initiatief aan de koper wordt terugbetaald.
Een betaling die door de bank van de koper namens hem wordt teruggedraaid. Je kunt deze betwisten. Zie Geschillen.

Bouwen op Whop

Platform betekent twee dingen in deze docs. Whop als platform is het product waarmee je integreert. Een platform in de zin van een marketplace ben jij, zodra je subaccounts inschrijft en een deel krijgt van wat zij verkopen. Uit de omringende zin blijkt welke betekenis wordt bedoeld.
app_
Software die binnen Whop draait en via de marketplace een publiek bereikt. Zie Apps.
Eén scherm dat een app binnen Whop weergeeft: de experience-weergave voor klanten, of de dashboardweergave voor creators. Zie App-weergaven.
Hoe Whop de pagina’s van je app insluit in de eigen interface. Je app draait op je eigen servers en wordt weergegeven binnen de interface van Whop. Zie iframe.
Eén afzonderlijke bevoegdheid die een API-sleutel mag uitoefenen. Zie Machtigingen.

Scope

Hetzelfde idee als een machtiging, maar dan op een OAuth-token: de verzameling dingen waarvan een gebruiker heeft ingestemd dat je app ze namens hem mag doen. Een machtiging is wat je sleutel kan doen. Een scope is wat een gebruiker je toestaat te doen. Zie de OAuth-gids.
Het record waarin staat dat een gebruiker je app heeft goedgekeurd voor een set scopes.
Een kant-en-klaar UI-component van Whop dat je in je eigen product plaatst, zodat je de interface niet zelf hoeft te bouwen.
Iets wat er in een account is gebeurd, zoals een geslaagde betaling.
Het HTTP-verzoek dat Whop naar je server stuurt om je te laten weten dat er een event heeft plaatsgevonden. Zie Webhooks.

Community

Een ruimte waarin leden elkaar berichten sturen. Zie Chat.
Eén post in een chatkanaal of een direct bericht.
Een ruimte met threads voor langere posts, los van de livechat. Zie Forums.
Eén thread in een forum, met de reacties en emoji-reacties erop.
Een bericht dat binnen Whop naar een gebruiker wordt gepusht. Elke verzending is afgebakend tot één experience of één gebruiker. Zie Meldingen.

Advertising

adcamp_
De container op het hoogste niveau voor betaalde advertenties op een advertentienetwerk. Bepaalt het platform, de doelstelling en de budgetstrategie. Zie Advertentiecampagnes.
adgrp_
Valt binnen een campagne en bepaalt de weergave: targeting, het optimalisatiedoel en de planning. Zie Advertentiegroepen.
ad_
De creatieve eenheid die een advertentiegroep weergeeft: tekst, assets en de bestemmings-URL. Zie Advertenties.
Een klantenlijst die naar Whop is geüpload en wordt gebruikt om mensen in een advertentiegroep te targeten of uit te sluiten. Zie Doelgroepen.

Verwijzingen en beloningen

aff_
Iemand die commissie verdient door kopers naar een product te sturen. Zie Affiliates.
Een gebruiker die is ingeschreven in het partnerprogramma van Whop en verdient aan de bedrijven die hij naar Whop doorverwijst. Zie Partners.
coma_
Een bedrijf dat een partner naar Whop heeft gebracht, met de commissietarieven en de verwijzingsperiode die erop van toepassing zijn.
Eén commissieregel voor een doorverwezen bedrijf, met de inkomstenbron waaruit deze afkomstig is en de status ervan.
bnty_
Een betaalde taak waarvan de beloning vanaf het moment van publicatie in escrow wordt gehouden. Zie Bounties.
btys_
De poging van één worker op een bounty, van de poging via de beoordeling tot de uitbetaling.

Omgevingen en sleutels

Whop heeft twee omgevingen. Ze delen niets. Zie Testen in de sandbox voor hoe je wisselt.
Sandbox- en productiesleutels zien er identiek uit. Niets in de sleutelstring vertelt je bij welke omgeving hij hoort, dus sla ze op onder verschillende namen en controleer dit voordat je iets uitvoert waarbij geld wordt verplaatst.
Vijf typen referenties hebben toegang tot de API. Kies op basis van wiens gegevens je nodig hebt. Zie Auth en API-sleutels voor hoe je elk type kiest en afbakent.
De header die je integratie vastzet op een gedateerde versie van de API, zodat latere wijzigingen de responsen waarop je hebt gebouwd niet veranderen. Zie API-versiebeheer.
Een waarde die je aan een POST toevoegt, zodat een nieuwe poging de oorspronkelijke respons opnieuw afspeelt in plaats van het werk twee keer uit te voeren. Zie Idempotente verzoeken.

ID-referentie

Elk object heeft een ID met een prefix. Wanneer je naar een payload kijkt, vertelt deze tabel je wat je in handen hebt.

Volgende stappen

Quickstart

Doe binnen een paar minuten je eerste API-aanroep.

Testen in de sandbox

Probeer alles uit met testgegevens voordat je live gaat.

API-overzicht

Hoe verzoeken, versiebeheer en paginering werken.

Wat je kunt bouwen

Het volledige overzicht van mogelijkheden, en de gids voor wat je bouwt.