Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Whop Elements er hostede UI-komponenter med temaunderstøttelse, som du indlejrer på dit eget website. Hvert element renderes i en isoleret frame, der leveres fra Whops CDN. Du installerer en tynd, fuldt typet pakke, og elementkoden holder sig selv opdateret.
Whop Elements er UI-komponenter med temaunderstøttelse, som du kan importere i din iOS-app. De leveres som en enkelt Swift SPM-pakke. Hver af dem er et almindeligt SwiftUI-view, der henter sine egne data og styrer sin egen tilstand, så en saldoskærm er et par views i en VStack i stedet for et netværkslag og en view model. Tilføj pakken, fortæl SDK’et, hvordan det henter et adgangstoken, og placér elementerne i dit view-hierarki.
Whop Elements er UI-komponenter med temaunderstøttelse, som du kan sætte direkte ind i en React Native-app. Det er ægte React Native-komponenter, ikke web views: felterne til betalingsmetoder, adresseformularen og kortfelterne er alle native input, og Apple Pay og Google Pay åbner platformens eget sheet. Installer pakken, fortæl SDK’et, hvordan det henter et adgangstoken, og montér elementerne.

Installation

Tilføj pakken til din Package.swift (eller File → Add Package Dependencies i Xcode):
Installer SDK’et:

Krav

Content Security Policy

contentSecurityPolicy() fra @whop/elements returnerer alle kilder i denne tabel for det miljø, du angiver. Rækkerne for arbejde på sidesiden kører på din side, ikke i en frame. De scripts, som elementer indlæser til Apple Pay, Google Pay og PayPal samt tilknytning af bankkonto via Plaid, kommer fra andre virksomheder og kan indlæse ressourcer ud over disse rækker. Tjek også hver udbyders vejledning om Content Security Policy.
Elements renderes i frames, der leveres fra cdn.whop.com. Noget af deres arbejde kører på din side og kalder api.whop.com derfra, som Apple Pay, Google Pay og PayPal samt tilknytning af bankkonto via Plaid. Hvis din CSP blokerer en af de to origins, får du et tomt område i stedet for elementet eller en mislykket forespørgsel, og fejlen vises kun i browserkonsollen.
Et modalt element nedtoner din side bag sig med en inline-style. En style-src, der ikke tillader inline-styles, efterlader siden unedtonet, men modalen fungerer stadig.

Før du starter

Du skal bruge to ting:
  1. Et accountId. Et konto-ID med præfikset biz_ eller et bruger-ID med præfikset user_ til brugerens egne data. Betalingsflader tager i stedet en plan eller et beløb, og hver elementside angiver, hvad den kræver.
  2. Et server-endpoint, der opretter et adgangstoken, afgrænset til de elementer, du monterer.
Placér aldrig en Whop API-nøgle i browserkode. Den opretter tokens, så alle, der åbner browserens udviklerværktøjer, kan læse kontoen. Opret tokenet på din server, og send kun tokenet.
Din server kalder Create Access Token med kontoen og de scopes, elementerne kræver:

Krav

Før du starter

Du skal bruge to ting:
  1. Et accountId. Et konto-ID med præfikset biz_ eller et bruger-ID med præfikset user_ til brugerens egen saldo.
  2. Et server-endpoint, der opretter et adgangstoken til kontoen. Send aldrig en Whop API-nøgle med i appen. Den opretter tokens, så alle, der udtrækker den, kan læse kontoen. Opret tokenet på din server, og returnér kun det.
Et user_…-tag læser seerens egne data, så det bruger seer-OAuth (WhopSDK.configureWithOAuth) i stedet for et token. Det samme gør chat-views.Din server kalder Create Access Token med kontoen og det scope, elementerne kræver:

Krav

Begge iOS-afhængighedsmanagere fungerer. Pakken leveres med både en ios/Package.swift og en podspec, og toolchainen vælger én. React Natives autolinker til Swift Package Manager foretrækker Package.swift, så en app, der allerede bruger SPM, påvirkes ikke af podspec’en. En app på CocoaPods, hvilket i dag omfatter alle Expo-apps, linker via podspec’en og behøver intet andet. Minimumsversionen af React Native er højere på SPM, fordi Package.swift linker to header-only XCFrameworks, der først blev leveret i 0.87.
Native kode er Swift og Kotlin genereret via React Native Codegen: intet her beder dig om at redigere Objective-C eller Java manuelt, og der er ingen native peer-afhængigheder at installere.

Før du starter

Du skal bruge to ting:
  1. Et accountId. Et virksomheds-ID med præfikset biz_.
  2. Et server-endpoint, der udsteder et adgangstoken til den konto. Send aldrig en Whop API-nøgle med i appen: den opretter tokens, så alle, der udtrækker den, kan handle som kontoen. Udsted tokenet på din server, og returnér kun det.
Din server kalder Create Access Token og giver resultatet tilbage til getToken.

Montér dit første element

En komplet app. configure kører én gang ved opstart, og elementerne renderer en spinner, indtil den er færdig, så intet kommer i konflikt med den:
En komplet checkout. <WhopElements> holder token-resolveren, <Payments> holder opkrævningen, og elementerne imellem dem indsamler den:
Foretrækker du npm frem for script-tagget? loadWhop() indsætter det samme hostede script og resolver den globale constructor:

Godkendelse

Angiv et accessToken, når du opretter handlet. Brug ét token til hele handlet, ikke ét pr. element. Handlet sender det token til alle elementer under det, så bed om alle de scopes, du har brug for, på det ene token. Hver elementside angiver de scopes, den læser.
Tokenet er en værdi, du angiver, ikke en callback, som SDK’et kalder. Sæt et nyt, før det udløber:
Hvis du udelader accessToken, bruger forespørgsler i stedet seerens sessionscookie. Dette fungerer kun på whop.com. API’et sender ikke Access-Control-Allow-Credentials ved cross-origin-preflights, så en side på dit eget domæne har ingen session at falde tilbage på og skal angive et token.

Global konfiguration

Alt, hvad du angiver ved oprettelsen, gælder for alle elementgrupper, der oprettes fra den instans (et handles egne indstillinger kan tilsidesætte pr. gruppe):
Appearance
Visuel tilpasning af alle elementer — theme (lys/mørk + paletter), variables (CSS custom properties) og classes (style-deklarationer pr. del). Farveskemaet anvendes før et elements første rendering, så mørke sider aldrig blinker lyst. Se Appearance.
string
Sprog for elementernes UI-tekst — et af appens indbyggede sprog; enhver anden værdi falder tilbage til standardsproget. Standard er "en".En af "en", "es", "zh", "nl", "pt", "de", "hu", "it", "fr", "ja", "pl" eller "tr".
"production" | "sandbox"
Hvilket Whop API-miljø elementerne taler med — "sandbox" går til sandbox-API’et (testdata; ingen rigtige penge flyttes). Valg af miljø er den eneste måde at ændre, hvor elementerne sender det, en køber indtaster, og begge miljøer er Whops egne. Sandbox-miljøet er endnu ikke generelt tilgængeligt. Standard er "production".
boolean
Om elementer må vise toast-notifikationer på din side — korte statusbeskeder (“Payment method added”, “Payment failed”), der renderes i nederste højre hjørne. Sæt false for at slå dem helt fra. Standard er true.
boolean
Spring Whop-pixlen over. Som standard indlæser elementer Whop-annoncepixlen på en side, der ikke allerede kører den, afgrænset til den konto, de arbejder for (en elementgruppes accountId eller sælgeren af en checkouts plan), og knytter elementanalyser til pixlens besøgs-id, en engangskobling af identitet, der gør elementaktivitet mulig at sammenkøre med dine data om annonceattribution i Whops identitetsgraf. Sæt true for at gøre ingen af delene. Selve brugsanalyserne påvirkes ikke (slå dem fra pr. handle med analytics: false). Standard er false.
I React bæres det samme objekt af <WhopElements appearance={…} locale={…}>.Den globale toasts er live på denne side — knappen nedenfor sender en via den samme kanal, som elementerne bruger, med denne sides appearance som tema:

Hvad elementerne håndterer, og hvad du selv står for

Hvert element henter sine egne data og renderer sine egne tilstande for indlæsning, tomhed og fejl.Du håndterer navigation og lagring. Elementer rapporterer valg og resultater som events og skriver aldrig til din database.Undtagelsen er et forløb, der forlader siden. Hvor et element tager en returnUrl, navigerer det fanen dertil, så køberen kan ende uden for din side. Køberen ankommer dertil efter et mislykket eller afbrudt eksternt trin såvel som efter et vellykket, med status (succeeded, failed eller canceled) og forsøgets ID tilføjet til URL’en, så siden på returnUrl skal læse status, før den viser en succesbesked. Lever ud fra webhooks i stedet for ud fra en browser-callback.Elementer kører i frames, så kun serialiserbare værdier krydser grænsen. Der er ingen delt DOM, og objektidentitet bevares ikke.

Fejlfinding

Tilgængelige elementer

Payments

Indsaml en betaling ud fra et plan_-ID eller en inline valuta og et beløb, eller gem en betalingsmetode uden opkrævning med mode: "setup".

Verifications

Indsamler og verificerer identitetsoplysninger for en konto.

Checkout

Driver en fuld hostet checkout for en eller flere planer — specificeret prisoversigt, rabatkoder, den valuta, køberen betaler i, og hele fladen til indsamling af betaling (betalingselementerne, sammensat indeni) — mod Whops API til checkout-sessioner.

Ads

En annoncekonto.

Tracking

En kontos sporede målgruppe: alle, som dens pixel har set, og alle events, de har udført.

Wallet

Driver en kontos pengeflader.

Websites

En kontos websites: alle sites bygget på whop.site plus alle domæner, som Whop Pixel rapporterer, med trafik og tilskrevet omsætning pr. domæne.

Dashboard

En kontos egne dashboard-flader, indlejret på dit website.

Delivery

Leveringssporing for en virksomheds kunder.

Chat

Realtidschat med en kanalliste og søgning i beskeder.

Næste trin

Godkendelse

getToken() er dit eneste integrationspunkt, og SDK’et kalder den igen, før tokenet udløber, så returnér et nyt token hver gang i stedet for at cache et:
Konfigurér én gang, et vilkårligt sted over elementerne. WhopSDK gælder for hele processen, så et andet kald er kun nødvendigt, når kontoen ændres:
Chat og DM’er godkender seeren i stedet for en konto via OAuth: WhopSDK.configureWithOAuth(appId:).

Temaer

.whopTheme(_:) udbredes gennem SwiftUI-miljøet, så ét kald giver alle elementer under det et tema. Seks roller, hver en WhopTint:
Standardværdierne er accent: .blue, neutral: .gray, danger: .red, info: .sky, success: .green, warning: .amber. WhopTheme.default er alle seks. Views følger selv systemets lyse/mørke udseende.

Hvad elementerne håndterer, og hvad du selv står for

Hvert view henter sine egne data og renderer sine egne tilstande for indlæsning, tomhed og fejl, inklusive et genforsøg. Du står for navigation: valg-callbacks giver dig en værdi og skubber aldrig en skærm.

Fejlfinding

Tilgængeligt på iOS

Wallet-views, hver med en live simulator på sin side:WhopChatView og WhopDMsListView leveres i samme pakke til chat med seergodkendelse. Se README.

Betalinger på iOS

Betalingselementerne leveres fra deres egen pakke, whopio/elements-swift, som udbyder et Elements-modul. Wallet-SDK’ets modul er WhopElements, så de to installeres side om side:
Modulet er Elements, ikke WhopElements, så import Elements er den eneste linje, der ændres. Opsætningen er også anderledes, og den deles op, som SwiftUI deler op: konfiguration nedarves fra app-roden, og én opkrævning er et scope. Intet kræver et token, fordi et bekræftelsestoken udstedes ud fra det, køberen har indtastet, og bekræftes på din server:
Kortdata indsamles af PCI-isolerede hostede inputs og kommer aldrig ind i din proces. Style alt med .whopElementsAppearance(_:) i stedet for .whopTheme(_:).

Godkendelse

getToken er dit eneste integrationspunkt, og SDK’et kalder den før hver forespørgsel, så returnér et nyt token i stedet for at cache et:
Et element, der ikke kræver legitimationsoplysninger, fungerer uden den, så du kan rendere en kortformular, før du forbinder din backend.

Modtag en betaling

Indsamling og bekræftelse er adskilt, og opdelingen er bevidst: appen ser aldrig et kortnummer, og din server stoler aldrig på klienten.
  1. Elementerne indsamler. Kortnumre går direkte fra PCI-isolerede inputs til et token, aldrig gennem din kode.
  2. createConfirmationToken() returnerer et bekræftelsestoken, som er sikkert at sende til din egen backend.
  3. Din backend bekræfter betalingen med Whop API’et.
  4. Hvis API’et svarer, at betalingen kræver mere fra køberen, så giv dens client_secret til handleNextAction(), og SDK’et kører 3D Secure- eller omdirigeringstrinnet.

Omdirigeringer og 3D Secure

Trin uden for appen åbner systembrowseren (ASWebAuthenticationSession på iOS, Custom Tabs på Android), aldrig et WebView, så udstederens side forbliver uden for din apps tillidsgrænse, og dens cookies forbliver uden for din apps cookie-lager.Sæt returnUrl på <Payments> til en https-URL, som du hoster. API’et afviser alt andet end https eller loopback (PaymentsApi::ValidateReturnUrl), så et brugerdefineret app-scheme virker ikke her — og du har ikke brug for et: handleNextAction poller betalingen, indtil den er afgjort, og lukker selv browseren i stedet for at vente på et deep link tilbage til din app.

Apple Pay og Google Pay

Wallet-felter vises, når platformen kan præsentere et sheet, og der er intet at sætte op for nogen af dem. Apple Pay bruger den merchant, der er registreret på Whop-kontoen, så din app kræver ingen merchant identifier og ingen Xcode-capability. googlePayMerchantName på <Payments> angiver kun det navn, der vises i sheetet.

Temaer

appearance på <WhopElements> giver alle elementer under det et tema med det samme theme-objekt, som webelementerne tager. Se Appearance.

Hvad elementerne håndterer, og hvad du selv står for

Hvert element henter sine egne data og renderer sine egne tilstande for indlæsning, tomhed og fejl. Du står for navigation og indsendelse: elementerne rapporterer via onChange og skubber aldrig en skærm eller kalder din backend.

Fejlfinding

Tilgængeligt i React Native

Betalingselementerne:Checkout-elementerne:
  • ExpressCheckoutElement: ét tryk på Apple Pay eller Google Pay, der betaler en hel checkout, under <Checkout>