Skip to main content
Bu sayfa, WhopCheckout SDK’sında bulunan tüm sınıfları, yöntemleri, özellikleri ve türleri belgeler.
Kılavuzlar için Bir ödeme duvarı oluşturun veya Yetkileri kontrol edin sayfalarına bakın.

Checkout

Uygulama içi satın almaları yönetmek için ana sınıf. SwiftUI’ın ortam sistemi bu @Observable sınıfı kullanabilir.

shared

Paylaşılan Checkout örneği. SDK’yı yapılandırmak ve satın almaları yönetmek için bu tekil örneği kullanın.
Örnek:

configure(companyId:apiKey:planMappings:)

SDK’yı yapılandırır ve başlatır. Bunu uygulama başlangıcında bir kez çağırın.
Parametreler: Örnek:

isInitialized

SDK’nın başlatmayı tamamlayıp tamamlamadığını belirtir.
Örnek:

deviceId

SDK tarafından yönetilen benzersiz cihaz tanımlayıcısı. iOS Anahtar Zinciri kullanılarak uygulama açılışları arasında kalıcı olur.

appUserId

Geçerli kullanıcının kimliği veya misafir için nil.

plans

Yapılandırılmış ürünler için mevcut abonelik varyantlarını içeren uyumluluk özelliği.
Örnek:

memberships

Geçerli kullanıcı veya cihaz için aktif üyeliklerin dizisi.

isSubscribed

Kullanıcının herhangi bir aktif üyeliği olup olmadığı.
Örnek:

supportsExternalPurchases

Geçerli App Store bölgesinin harici (StoreKit dışı) satın almaları destekleyip desteklemediği. Şu anda Amerika Birleşik Devletleri’ndeki kullanıcılar için true, diğer yerlerde false değerindedir.
true olduğunda SDK varsayılan olarak Whop web ödeme sayfasını (daha düşük ücretler) kullanır. false olduğunda varsayılan olarak StoreKit’i kullanır.

refreshPlans()

Mevcut varyantları sunucudan yeniler.
Döndürür: Güncel fiyatlarla yenilenmiş varyantlar. Fırlatır: Yenileme başarısız olursa WhopCheckoutError. Başlatmadan sonra fiyatları veya varyant kullanılabilirliğini güncellemek için bunu çağırın. Bu, uyumluluk özelliği plans değerini de en son verilerle günceller. Örnek:

hasAccess(to:)

Kullanıcının belirli bir ürüne erişimi olup olmadığını kontrol eder.
Parametreler: Döndürür: Kullanıcının ürün için aktif bir üyeliği varsa true Örnek:

purchase(_:method:)

Bir varyant için satın alma akışını başlatır. Varsayılan olarak Amerika Birleşik Devletleri’nde Whop web ödeme sayfasını (daha düşük ücretler), diğer yerlerde StoreKit’i kullanır.
Parametreler: Döndürür: Makbuz kimliğini ve üyelik bilgilerini içeren CheckoutPurchaseResult Fırlatır:
  • Kullanıcı ödeme sayfasını kapatırsa WhopCheckoutError.cancelled
  • SDK yapılandırılmamışsa WhopCheckoutError.notConfigured
  • Ödeme başarısız olursa WhopCheckoutError.paymentFailed(String)
Örnek:
Apple Pay için Checkout.ApplePayButton kullanın veya arayüzünüz Apple Pay’i özel bir etkileşimden tetikliyorsa presentApplePay(_:) kullanın.

logIn(appUserId:)

Bir kullanıcının oturumunu açar ve cihazla ilişkili sahiplenilmemiş üyelikleri sahiplenir.
Parametreler: Örnek:

logOut()

Geçerli kullanıcının oturumunu kapatır ve üyeliklerini yerel durumdan temizler.
Örnek:

restorePurchases()

Satın almaları hem StoreKit’ten hem de Whop’tan geri yükler.
Döndürür: SDK aktif bir abonelik bulduysa true Örnek:

Türler

CheckoutPurchaseResult

Başarılı bir satın almanın sonucu.
membership özelliği kullanılan ödeme yöntemine bağlıdır:StoreKit satın almaları neden nil döndürür: StoreKit işlemleri Apple tarafından eşzamansız olarak işlenir. Satın alma tamamlandığında SDK, Whop üyeliğini henüz senkronize etmemiş olabilir. SDK StoreKit yetkilerini de takip eder, bu nedenle checkout.isSubscribed yine de true döndürür.Her iki durum nasıl yönetilir:
Önemli nokta: Erişim vermek için membership değerinin nil olmamasına güvenmeyin. Abonelik durumunu kontrol etmek için her zaman checkout.isSubscribed veya checkout.hasAccess(to:) kullanın.

PlanMapping

SDK yapılandırması sırasında kullanılan, bir Whop varyantı ile bir Apple StoreKit ürünü arasındaki eşleme. Bu, SDK’ya Amerika Birleşik Devletleri dışındaki StoreKit satın almaları için hangi Apple ürününü kullanacağını söyler.
PlanMapping ve CheckoutPlan karşılaştırması: PlanMapping SDK yapılandırması içindir (kimlik eşleme). CheckoutPlan ise arayüzünüzde gösterdiğiniz şeydir (fiyat, başlık vb. içerir). PlanMapping nesnelerini configure() içinde oluşturursunuz, ardından CheckoutPlan nesnelerine checkout.plans aracılığıyla erişirsiniz.
Örnek:
Whop varyantlarınız ve Apple ürünleriniz eşleşen fiyatlara ve faturalandırma dönemlerine sahip olmalıdır. Uyumluluk API’si ayrıntıları için PlanMapping bölümüne bakın.

PaymentMethod

Bir satın alma için kullanılacak ödeme yöntemi.
Apple Pay PaymentMethod içinde yer almaz; kendi arayüzleri vardır: Checkout.ApplePayButton ve presentApplePay(_:).

Checkout.ApplePayButton

Apple’ın resmi Apple Pay düğmesini oluşturan ve tüm satın alma akışını yöneten, önceden oluşturulmuş bir SwiftUI görünümü. Apple Pay sunarken bu bileşeni (veya PKPaymentButton / PayWithApplePayButton) kullanmanız gerekir; özel stilli düğmelere Apple’ın Human Interface Guidelines yönergeleri izin vermez.
Parametreler: Örnek:
Apple Pay dijital içerik için değildir. Checkout.ApplePayButton öğesini yalnızca uygulamanız fiziksel ürünler veya gerçek dünya hizmetleri satıyorsa kullanın. Dijital içerik (premium özelliklere abonelikler, uygulama içi para birimi vb.) satan uygulamalar StoreKit kullanmalıdır. Aşağıdaki Apple Pay uygunluğu bölümüne bakın.

presentApplePay(_:)

Apple Pay’i önceden oluşturulmuş düğme yerine özel bir etkileşimden (örneğin kaydırarak ödeme kontrolü) başlatan arayüzler için Apple Pay sayfasını doğrudan sunar.
Bunu yalnızca bir kullanıcı etkileşimine doğrudan yanıt olarak çağırın; Apple, bir ödeme sayfasının yalnızca kullanıcı açıkça ödeme yapmak istediğinde sunulmasına izin verir. Kullanıcı sayfayı kapattığında WhopCheckoutError.cancelled fırlatır.
Checkout.ApplePayButton için geçerli olan Apple Pay uygunluğu kuralları burada da geçerlidir.

CheckoutPlan görüntüleme modeli

Uyumluluk özelliği checkout.plans aracılığıyla erişilen, satın alınabilir bir abonelik varyantı. Bunu arayüzünüzde varyant bilgilerini göstermek ve satın alma yapmak için kullanın.
Uyumluluk türleri: CheckoutPlan, arayüzünüz için eksiksiz varyant ayrıntılarını (fiyat, başlıklar, deneme bilgisi) içerir. Plan, SDK yapılandırması sırasında kullanılan bir kimlik eşlemesidir. CheckoutPlan nesnelerini asla siz oluşturmazsınız; bunlar yapılandırmadan sonra checkout.plans üzerinden gelir.

CheckoutMembership

Aktif bir abonelik üyeliği.

WhopCheckoutError

SDK tarafından fırlatılan hatalar.

Apple Pay uygunluğu

Çoğu uygulama Apple Pay kullanmamalıdır. WhopCheckout SDK aracılığıyla Apple Pay yalnızca fiziksel ürünler veya gerçek dünya hizmetleri satan uygulamalar içindir; dijital içerik, uygulama özelliklerine abonelikler veya uygulama içi para birimi için değildir.

App Store inceleme yönergeleri

Apple’ın App Store Review Guideline 3.1.1 yönergesi, dijital ürün ve hizmetlerin (premium özellikler, abonelikler, içerik kilidi açma, sanal para birimi) In-App Purchase (StoreKit) kullanmasını zorunlu kılar. Bu işlemler için Apple Pay açıkça yasaktır. Guideline 3.1.3(e) ve Apple Pay yönergeleri, fiziksel ürünlerin ve gerçek dünya hizmetlerinin satın alınması için Apple Pay’e izin verir.

Uygun uygulamalar

Apple Pay (Checkout.ApplePayButton) kullanabilen uygulamalar: StoreKit (.storeKit) veya Whop web ödeme sayfası (.whop) kullanması gereken uygulamalar:

Nasıl seçilir

Uygulamanız uygunsa Checkout.ApplePayButton kullanın. Uygulamanızın uygun olup olmadığından emin değilseniz varsayılan olarak .whop (Amerika Birleşik Devletleri) veya .storeKit (diğer yerler) kullanın. Bir yöntem belirtmeden purchase() çağırdığınızda SDK bunu otomatik olarak yönetir.

Gereksinimler

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