Skip to main content
Denne side dokumenterer alle klasser, metoder, egenskaber og typer, der er tilgængelige i WhopCheckout-SDK’et.

Checkout

Hovedklassen til håndtering af køb i appen. SwiftUI’s environment-system kan bruge denne @Observable-klasse.

shared

Den delte Checkout-instans. Brug denne singleton til at konfigurere SDK’et og håndtere køb.
Eksempel:

configure(companyId:apiKey:planMappings:)

Konfigurerer og initialiserer SDK’et. Kald dette én gang ved app-start.
Parametre: Eksempel:

isInitialized

Angiver, om SDK’et er færdig med at initialisere.
Eksempel:

deviceId

Den unikke enhedsidentifikator, som SDK’et administrerer. Bevares på tværs af app-starter ved hjælp af iOS-nøgleringen.

appUserId

Den aktuelle brugers ID eller nil for en gæst.

plans

Kompatibilitetsegenskab, der indeholder de tilgængelige abonnementsvarianter for de konfigurerede produkter.
Eksempel:

memberships

Array med aktive medlemskaber for den aktuelle bruger eller enhed.

isSubscribed

Om brugeren har et aktivt medlemskab.
Eksempel:

supportsExternalPurchases

Om den aktuelle App Store-region understøtter eksterne køb (uden StoreKit). I øjeblikket true for brugere i USA og false andre steder.
Når true, bruger SDK’et som standard Whops webcheckout (lavere gebyrer). Når false, bruger det som standard StoreKit.

refreshPlans()

Opdaterer de tilgængelige varianter fra serveren.
Returnerer: De opdaterede varianter med aktuelle priser. Kaster: WhopCheckoutError, hvis opdateringen fejler. Kald dette for at opdatere priser eller tilgængelighed af varianter efter initialisering. Det opdaterer også kompatibilitetsegenskaben plans med de seneste data. Eksempel:

hasAccess(to:)

Tjekker, om brugeren har adgang til et bestemt produkt.
Parametre: Returnerer: true, hvis brugeren har et aktivt medlemskab af produktet Eksempel:

purchase(_:method:)

Starter et købsforløb for en variant. Bruger som standard Whops webcheckout i USA (lavere gebyrer) og StoreKit andre steder.
Parametre: Returnerer: CheckoutPurchaseResult med kvitterings-ID og oplysninger om medlemskabet Kaster:
  • WhopCheckoutError.cancelled, hvis brugeren lukker checkouten
  • WhopCheckoutError.notConfigured, hvis SDK’et ikke er konfigureret
  • WhopCheckoutError.paymentFailed(String), hvis betalingen fejler
Eksempel:
Til Apple Pay skal du bruge Checkout.ApplePayButton eller presentApplePay(_:), når din brugerflade udløser Apple Pay fra en brugerdefineret interaktion.

logIn(appUserId:)

Logger en bruger ind og gør krav på alle ikke-tilknyttede medlemskaber, der er knyttet til enheden.
Parametre: Eksempel:

logOut()

Logger den aktuelle bruger ud og rydder brugerens medlemskaber fra den lokale tilstand.
Eksempel:

restorePurchases()

Gendanner køb fra både StoreKit og Whop.
Returnerer: true, hvis SDK’et fandt et aktivt abonnement Eksempel:

Typer

CheckoutPurchaseResult

Resultatet af et vellykket køb.
Egenskaben membership afhænger af den anvendte betalingsmetode:Hvorfor StoreKit-køb returnerer nil: StoreKit-transaktioner behandles asynkront af Apple. Når købet gennemføres, har SDK’et måske endnu ikke synkroniseret Whop-medlemskabet. SDK’et sporer også StoreKit-rettigheder, så checkout.isSubscribed returnerer stadig true.Sådan håndterer du begge tilfælde:
Vigtigt: Stol ikke på, at membership ikke er nil, for at give adgang. Brug altid checkout.isSubscribed eller checkout.hasAccess(to:) til at tjekke abonnementsstatus.

PlanMapping

En mapping mellem en Whop-variant og et Apple StoreKit-produkt, der bruges under konfigurationen af SDK’et. Den fortæller SDK’et, hvilket Apple-produkt der skal bruges til StoreKit-køb uden for USA.
PlanMapping vs. CheckoutPlan: PlanMapping er til konfiguration af SDK’et (mapping af ID’er). CheckoutPlan er det, du viser i din brugerflade (har priser, titler osv.). Du opretter PlanMapping-objekter i configure() og får derefter adgang til CheckoutPlan-objekter via checkout.plans.
Eksempel:
Dine Whop-varianter og Apple-produkter bør have matchende priser og faktureringsperioder. Se PlanMapping for detaljer om kompatibilitets-API’et.

PaymentMethod

Den betalingsmetode, der skal bruges til et køb.
Apple Pay er ikke inkluderet i PaymentMethod – det har sine egne flader: Checkout.ApplePayButton og presentApplePay(_:).

Checkout.ApplePayButton

En færdigbygget SwiftUI-visning, der renderer Apples officielle Apple Pay-knap og håndterer hele købsforløbet. Du skal bruge denne komponent (eller PKPaymentButton / PayWithApplePayButton), når du tilbyder Apple Pay – knapper med brugerdefineret styling er ikke tilladt ifølge Apples Human Interface Guidelines.
Parametre: Eksempel:
Apple Pay er ikke til digitalt indhold. Brug kun Checkout.ApplePayButton, hvis din app sælger fysiske varer eller tjenester i den virkelige verden. Apps, der sælger digitalt indhold (abonnementer på premiumfunktioner, valuta i appen osv.), skal bruge StoreKit. Se afsnittet Berettigelse til Apple Pay nedenfor.

presentApplePay(_:)

Viser Apple Pay-arket direkte til brugerflader, der starter Apple Pay fra en brugerdefineret interaktion (f.eks. en skub-for-at-betale-kontrol) i stedet for den færdigbyggede knap.
Kald det kun som direkte svar på en brugerinteraktion – Apple tillader kun at vise et betalingsark, når brugeren udtrykkeligt har bedt om at betale. Kaster WhopCheckoutError.cancelled, når brugeren lukker arket.
De samme regler for berettigelse til Apple Pay gælder som for Checkout.ApplePayButton.

Visningsmodellen CheckoutPlan

En abonnementsvariant, der kan købes, og som tilgås via kompatibilitetsegenskaben checkout.plans. Brug den til at vise variantoplysninger i din brugerflade og til at foretage køb.
Kompatibilitetstyper: CheckoutPlan indeholder alle variantoplysninger (priser, titler, info om prøveperiode) til din brugerflade. Plan er en ID-mapping, der bruges under konfigurationen af SDK’et. Du opretter aldrig selv CheckoutPlan-objekter – de kommer fra checkout.plans efter konfigurationen.

CheckoutMembership

Et aktivt abonnementsmedlemskab.

WhopCheckoutError

Fejl, som SDK’et kaster.

Berettigelse til Apple Pay

De fleste apps bør ikke bruge Apple Pay. Apple Pay via WhopCheckout-SDK’et er kun til apps, der sælger fysiske varer eller tjenester i den virkelige verden – ikke digitalt indhold, abonnementer på appfunktioner eller valuta i appen.

Retningslinjer for App Store-gennemgang

Apples App Store Review Guideline 3.1.1 kræver, at digitale varer og tjenester (premiumfunktioner, abonnementer, oplåsning af indhold, virtuel valuta) skal bruge In-App Purchase (StoreKit). Apple Pay er udtrykkeligt forbudt til disse transaktioner. Guideline 3.1.3(e) og Apple Pay-retningslinjerne tillader Apple Pay til køb af fysiske varer og tjenester i den virkelige verden.

Apps, der opfylder kravene

Apps, der kan bruge Apple Pay (Checkout.ApplePayButton): Apps, der skal bruge StoreKit (.storeKit) eller Whops webcheckout (.whop):

Sådan vælger du

Hvis din app opfylder kravene, skal du bruge Checkout.ApplePayButton. Hvis du er i tvivl om, hvorvidt din app opfylder kravene, skal du som standard bruge .whop (USA) eller .storeKit (andre steder). SDK’et håndterer dette automatisk, når du kalder purchase() uden at angive en metode.

Krav

  • iOS 17.0+
  • Xcode 15.0+
  • Swift 5.10+