Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Whop Elements zijn gehoste UI-componenten met aanpasbare thema’s die je in je eigen site insluit. Elk element wordt weergegeven in een geïsoleerd frame dat vanaf het CDN van Whop wordt geleverd. Je installeert een dun, volledig getypeerd pakket en de elementcode blijft vanzelf up-to-date.
Whop Elements zijn UI-componenten met aanpasbare thema’s die je in je iOS-app kunt importeren. Ze worden geleverd als één Swift SPM-pakket. Elk component is een gewone SwiftUI-view die zijn eigen gegevens ophaalt en zijn eigen status beheert, zodat een saldoscherm uit een paar views in een VStack bestaat in plaats van een netwerklaag en een viewmodel. Voeg het pakket toe, vertel de SDK hoe die een toegangstoken ophaalt, en plaats de elementen in je viewhiërarchie.
Whop Elements zijn UI-componenten met aanpasbare thema’s die je in een React Native-app kunt plaatsen. Het zijn echte React Native-componenten, geen webviews: de tegels voor betaalmethoden, het adresformulier en de kaartvelden zijn allemaal native invoer, en Apple Pay en Google Pay openen de eigen sheet van het platform. Installeer het pakket, vertel de SDK hoe die een toegangstoken ophaalt, en mount de elementen.

Installatie

Voeg het pakket toe aan je Package.swift (of File → Add Package Dependencies in Xcode):
Installeer de SDK:

Vereisten

Content Security Policy

contentSecurityPolicy() uit @whop/elements retourneert elke bron in deze tabel, voor de omgeving die je meegeeft. De rijen voor werk aan de paginazijde worden op je pagina uitgevoerd, niet in een frame. De scripts die elementen laden voor Apple Pay, Google Pay en PayPal en voor Plaid-bankrekeningkoppeling komen van andere bedrijven en kunnen resources laden die buiten deze rijen vallen. Raadpleeg ook de Content Security Policy-richtlijnen van elke provider.
Elementen worden weergegeven in frames die worden geleverd vanaf cdn.whop.com. Een deel van hun werk wordt op je pagina uitgevoerd en roept vandaaruit api.whop.com aan, zoals Apple Pay, Google Pay en PayPal en Plaid-bankrekeningkoppeling. Als je CSP een van beide origins blokkeert, krijg je lege ruimte in plaats van het element of een mislukt verzoek, en de fout verschijnt alleen in de browserconsole.
Een modaal element dimt je pagina erachter met een inline style. Een style-src die geen inline styles toestaat, laat de pagina ongedimd, maar de modal werkt nog steeds.

Voordat je begint

Je hebt twee dingen nodig:
  1. Een accountId. Een account-ID, met prefix biz_, of een gebruikers-ID, met prefix user_, voor de eigen gegevens van de gebruiker. Betaaloppervlakken accepteren in plaats daarvan een abonnement of bedrag, en elke elementpagina vermeldt wat die nodig heeft.
  2. Een server-endpoint dat een toegangstoken aanmaakt, met een scope voor de elementen die je mount.
Zet nooit een Whop API-sleutel in browsercode. Die maakt tokens aan, dus iedereen die de ontwikkelaarstools van de browser opent, kan het account lezen. Maak het token aan op je server en verstuur alleen het token.
Je server roept Create Access Token aan met het account en de scopes die de elementen nodig hebben:

Vereisten

Voordat je begint

Je hebt twee dingen nodig:
  1. Een accountId. Een account-ID, met prefix biz_, of een gebruikers-ID, met prefix user_, voor het eigen saldo van de gebruiker.
  2. Een server-endpoint dat een toegangstoken aanmaakt voor het account. Lever nooit een Whop API-sleutel mee in de app. Die maakt tokens aan, dus iedereen die de sleutel eruit haalt, kan het account lezen. Maak het token aan op je server en retourneer alleen dat.
Een user_…-tag leest de eigen gegevens van de kijker, dus die gebruikt viewer-OAuth (WhopSDK.configureWithOAuth) in plaats van een token. Dat geldt ook voor de chatviews.Je server roept Create Access Token aan met het account en de scope die de elementen nodig hebben:

Vereisten

Beide iOS-dependencymanagers werken. Het pakket bevat zowel een ios/Package.swift als een podspec, en de toolchain kiest er een. De Swift Package Manager-autolinker van React Native geeft de voorkeur aan Package.swift, dus een app die al SPM gebruikt, wordt niet beïnvloed door de podspec. Een app met CocoaPods, wat momenteel voor elke Expo-app geldt, koppelt via de podspec en heeft verder niets nodig. De minimale React Native-versie is hoger met SPM omdat Package.swift twee header-only XCFrameworks koppelt die voor het eerst in 0.87 zijn uitgebracht.
Native code is Swift en Kotlin, gegenereerd via React Native Codegen: niets hier vraagt je om Objective-C of Java handmatig te bewerken, en er zijn geen native peer-dependencies om te installeren.

Voordat je begint

Je hebt twee dingen nodig:
  1. Een accountId. Een bedrijfs-ID, met prefix biz_.
  2. Een server-endpoint dat een toegangstoken aanmaakt voor dat account. Lever nooit een Whop API-sleutel mee in de app: die maakt tokens aan, dus iedereen die de sleutel eruit haalt, kan namens het account handelen. Maak het token aan op je server en retourneer alleen dat.
Je server roept Create Access Token aan en geeft het resultaat terug aan getToken.

Je eerste element mounten

Een volledige app. configure wordt eenmaal bij het opstarten uitgevoerd, en de elementen tonen een spinner totdat het klaar is, dus niets loopt ervoor uit:
Een volledige checkout. <WhopElements> bevat de tokenresolver, <Payments> bevat de afschrijving, en de elementen daartussen verzamelen de gegevens:
Gebruik je liever npm dan de scripttag? loadWhop() injecteert hetzelfde gehoste script en levert de globale constructor op:

Authenticatie

Geef een accessToken mee wanneer je de handle aanmaakt. Gebruik één token voor de hele handle, niet één per element. De handle stuurt dat token naar elk element eronder, dus vraag alle scopes die je nodig hebt aan voor dat ene token. Elke elementpagina vermeldt de scopes die het leest.
Het token is een waarde die je instelt, geen callback die de SDK aanroept. Stel een nieuw token in voordat het verloopt:
Als je accessToken weglaat, gebruiken verzoeken in plaats daarvan de sessiecookie van de kijker. Dit werkt alleen op whop.com. De API stuurt geen Access-Control-Allow-Credentials bij cross-origin preflights, dus een pagina op je eigen domein heeft geen sessie om op terug te vallen en moet een token meegeven.

Globale configuratie

Alles wat je bij de constructie meegeeft, geldt voor elke elementgroep die vanuit die instantie wordt aangemaakt (de eigen opties van een handle kunnen dit per groep overschrijven):
Appearance
Visuele aanpassing voor elk element — theme (licht/donker + paletten), variables (CSS custom properties) en classes (stijldeclaraties per onderdeel). Het kleurenschema wordt toegepast vóór de eerste weergave van een element, zodat donkere pagina’s nooit licht oplichten. Zie Appearance.
string
Taalinstelling voor de UI-tekst van elementen — een van de ingebouwde taalinstellingen van de app; elke andere waarde valt terug op de standaardtaalinstelling. Standaard "en".Een van "en", "es", "zh", "nl", "pt", "de", "hu", "it", "fr", "ja", "pl" of "tr".
"production" | "sandbox"
Met welke Whop API-omgeving de elementen communiceren — "sandbox" richt zich op de sandbox-API (testgegevens; er wordt geen echt geld verplaatst). Het kiezen van een omgeving is de enige manier om te wijzigen waarheen de elementen versturen wat een koper typt, en beide omgevingen zijn van Whop zelf. De sandboxomgeving is nog niet algemeen beschikbaar. Standaard "production".
boolean
Of elementen toastmeldingen op je pagina mogen tonen — korte statusberichten (“Payment method added”, “Payment failed”) die rechtsonder worden weergegeven. Stel in op false om ze volledig uit te schakelen. Standaard true.
boolean
Sla de Whop-pixel over. Standaard laden elementen de Whop-advertentiepixel op een pagina die deze nog niet uitvoert, met een scope voor het account waarvoor ze werken (de accountId van een elementgroep, of de verkoper van het abonnement van een checkout), en koppelen ze elementanalytics aan de bezoekers-ID van de pixel, een eenmalige identiteitskoppeling die elementactiviteit koppelbaar maakt aan je advertentie-attributiegegevens in de identiteitsgraaf van Whop. Stel in op true om geen van beide te doen. Gebruiksanalytics zelf worden niet beïnvloed (schakel die per handle uit met analytics: false). Standaard false.
In React gaat hetzelfde object mee met <WhopElements appearance={…} locale={…}>.De globale instelling toasts is live op deze pagina — de knop hieronder verstuurt er een via dezelfde rail die elementen gebruiken, met het thema van de appearance van deze pagina:

Wat de elementen afhandelen en wat jij beheert

Elk element haalt zijn eigen gegevens op en geeft zijn eigen laad-, lege en foutstatussen weer.Jij verzorgt navigatie en opslag. Elementen melden selecties en resultaten als events en schrijven nooit naar je database.De uitzondering is een flow die de pagina verlaat. Wanneer een element een returnUrl accepteert, navigeert het het tabblad daarheen, zodat de koper buiten je pagina kan belanden. De koper komt daar terecht na een mislukte of afgebroken externe stap en ook na een geslaagde, met status (succeeded, failed of canceled) en het ID van de poging toegevoegd aan de URL, dus de pagina op returnUrl moet status lezen voordat die een succesmelding toont. Lever via webhooks in plaats van via een browsercallback.Elementen draaien in frames, dus alleen serialiseerbare waarden gaan over de grens. Er is geen gedeelde DOM en objectidentiteit blijft niet behouden.

Probleemoplossing

Beschikbare elementen

Payments

Int een betaling op basis van een plan_-ID of een inline valuta en bedrag, of sla een betaalmethode op zonder af te schrijven met mode: "setup".

Verifications

Verzamelt en verifieert identiteitsgegevens voor een account.

Checkout

Stuurt een volledige gehoste checkout aan voor een of meer abonnementen — gespecificeerd prijsoverzicht, promotiecodes, de valuta waarin de koper betaalt en het volledige oppervlak voor het innen van betalingen (de betaalelementen, daarbinnen samengesteld) — via de Whop checkout sessions API.

Ads

Een advertentieaccount.

Tracking

Het gevolgde publiek van een account: iedereen die de pixel heeft gezien, en elk event dat ze hebben uitgevoerd.

Wallet

Stuurt de geldoppervlakken van een account aan.

Websites

De websites van een account: elke site die op whop.site is gebouwd plus elk domein dat de Whop Pixel rapporteert, met verkeer en toegeschreven omzet per domein.

Dashboard

De eigen dashboardoppervlakken van een account, ingesloten op je site.

Delivery

Leveringstracking voor klanten van een bedrijf.

Chat

Realtime chat met een kanalenlijst en zoeken in berichten.

Volgende

Authenticatie

getToken() is je enige integratiepunt, en de SDK roept het opnieuw aan voordat het token verloopt, dus retourneer elke keer een nieuw token in plaats van er een te cachen:
Configureer eenmaal, ergens boven de elementen. WhopSDK geldt voor het hele proces, dus een tweede aanroep is alleen nodig wanneer het account verandert:
Chat en DM’s authenticeren de kijker in plaats van een account, via OAuth: WhopSDK.configureWithOAuth(appId:).

Thema’s

.whopTheme(_:) wordt doorgegeven via de SwiftUI-omgeving, dus één aanroep geeft elk element eronder een thema. Zes rollen, elk een WhopTint:
De standaardwaarden zijn accent: .blue, neutral: .gray, danger: .red, info: .sky, success: .green, warning: .amber. WhopTheme.default bevat alle zes. Views volgen zelf de lichte/donkere weergave van het systeem.

Wat de elementen afhandelen en wat jij beheert

Elke view haalt zijn eigen gegevens op en geeft zijn eigen laad-, lege en foutstatussen weer, inclusief een nieuwe poging. Jij beheert de navigatie: de selectiecallbacks geven je een waarde en pushen nooit een scherm.

Probleemoplossing

Beschikbaar op iOS

De wallet-views, elk met een live simulator op de eigen pagina:WhopChatView en WhopDMsListView worden in hetzelfde pakket geleverd voor chat met kijkerauthenticatie. Zie de README.

Betalingen op iOS

De betaalelementen worden geleverd vanuit een eigen pakket, whopio/elements-swift, dat een Elements-module levert. De module van de wallet-SDK is WhopElements, dus de twee kunnen naast elkaar worden geïnstalleerd:
De module is Elements, niet WhopElements, dus import Elements is de enige regel die verandert. Ook de setup verschilt, en die is opgesplitst zoals SwiftUI dat doet: configuratie wordt overgenomen van de app-root, en één afschrijving is een scope. Er is geen token nodig, omdat een bevestigingstoken wordt aangemaakt op basis van wat de koper heeft getypt en op je server is bevestigd:
Kaartgegevens worden vastgelegd door PCI-geïsoleerde gehoste invoer en komen nooit in je proces terecht. Style alles met .whopElementsAppearance(_:) in plaats van .whopTheme(_:).

Authenticatie

getToken is je enige integratiepunt, en de SDK roept het vóór elk verzoek aan, dus retourneer een nieuw token in plaats van er een te cachen:
Een element dat geen referenties nodig heeft, werkt ook zonder, dus je kunt een kaartformulier weergeven voordat je je backend koppelt.

Een betaling ontvangen

Verzamelen en bevestigen zijn gescheiden, en die scheiding is bewust: de app ziet nooit een kaartnummer en je server vertrouwt de client nooit.
  1. De elementen verzamelen. Kaartnummers gaan rechtstreeks van PCI-geïsoleerde invoer naar een token, nooit via je code.
  2. createConfirmationToken() retourneert een bevestigingstoken, dat veilig naar je eigen backend kan worden gestuurd.
  3. Je backend bevestigt de betaling met de Whop API.
  4. Als de API antwoordt dat de betaling meer van de koper nodig heeft, geef dan de client_secret ervan door aan handleNextAction() en de SDK voert de 3D Secure- of redirectstap uit.

Redirects en 3D Secure

Stappen buiten de app openen de systeembrowser (ASWebAuthenticationSession op iOS, Custom Tabs op Android), nooit een WebView, zodat de pagina van de uitgever buiten de vertrouwensgrens van je app blijft en de cookies ervan buiten de cookie-opslag van je app.Stel returnUrl op <Payments> in op een https-URL die je zelf host. De API weigert alles behalve https of loopback (PaymentsApi::ValidateReturnUrl), dus een aangepast app-schema werkt hier niet — en dat heb je ook niet nodig: handleNextAction pollt de betaling tot die in rust is en sluit de browser zelf, in plaats van te wachten op een deeplink terug naar je app.

Apple Pay en Google Pay

Wallettegels verschijnen zodra het platform een sheet kan tonen, en voor geen van beide hoef je iets in te stellen. Apple Pay gebruikt de merchant die bij het Whop-account is geregistreerd, dus je app heeft geen merchant-ID en geen Xcode-capability nodig. googlePayMerchantName op <Payments> stelt alleen de naam in die in de sheet wordt getoond.

Thema’s

appearance op <WhopElements> geeft elk element eronder een thema, met hetzelfde theme-object dat de webelementen accepteren. Zie Appearance.

Wat de elementen afhandelen en wat jij beheert

Elk element haalt zijn eigen gegevens op en geeft zijn eigen laad-, lege en foutstatussen weer. Jij beheert navigatie en verzending: de elementen melden via onChange en pushen nooit een scherm of roepen nooit je backend aan.

Probleemoplossing

Beschikbaar in React Native

De betaalelementen:De checkoutelementen:
  • ExpressCheckoutElement: één druk op Apple Pay of Google Pay die een volledige checkout betaalt, onder <Checkout>