Skip to main content
Bu sayfa @whop/elements@1.10.0 ve @whop/elements-react@1.10.0 sürümlerini belgeler.
Whop Elements, kendi sitenize gömdüğünüz, barındırılan ve tema uygulanabilen arayüz bileşenleridir. Her element, Whop’un CDN’inden sunulan yalıtılmış bir çerçevede görüntülenir. İnce, tamamen tiplendirilmiş bir paket kurarsınız ve element kodu kendiliğinden güncel kalır.
Whop Elements, iOS uygulamanıza içe aktarabileceğiniz, tema uygulanabilen arayüz bileşenleridir. Tek bir Swift SPM paketi olarak sunulurlar. Her biri kendi verilerini getiren ve kendi durumunu yöneten sade bir SwiftUI görünümüdür; böylece bir bakiye ekranı, bir ağ katmanı ve bir görünüm modeli yerine bir VStack içindeki birkaç görünümden ibarettir. Paketi ekleyin, SDK’ya bir erişim token’ını nasıl alacağını söyleyin ve elementleri görünüm hiyerarşinize yerleştirin.
Whop Elements, bir React Native uygulamasına ekleyebileceğiniz, tema uygulanabilen arayüz bileşenleridir. Web görünümleri değil, gerçek React Native bileşenleridir: ödeme yöntemi kutucukları, adres formu ve kart alanlarının tümü yerel girişlerdir; Apple Pay ve Google Pay ise platformun kendi sayfasını açar. Paketi kurun, SDK’ya bir erişim token’ını nasıl alacağını söyleyin ve elementleri bağlayın.

Kurulum

Paketi Package.swift dosyanıza ekleyin (veya Xcode’da File → Add Package Dependencies):
SDK’yı kurun:

Gereksinimler

İçerik güvenliği politikası

@whop/elements paketindeki contentSecurityPolicy(), ilettiğiniz ortam için bu tablodaki her kaynağı döndürür. Sayfa tarafı işlere ait satırlar bir çerçevede değil, sizin sayfanızda çalışır. Elementlerin Apple Pay, Google Pay ve PayPal ile Plaid banka hesabı bağlama için yüklediği betikler başka şirketlerden gelir ve bu satırların ötesinde kaynaklar yükleyebilir. Her sağlayıcının İçerik Güvenliği Politikası rehberini de kontrol edin.
Elementler cdn.whop.com adresinden sunulan çerçevelerde görüntülenir. Apple Pay, Google Pay ve PayPal ile Plaid banka hesabı bağlama gibi işlerinin bir kısmı sizin sayfanızda çalışır ve oradan api.whop.com adresini çağırır. CSP’niz bu kaynaklardan herhangi birini engellerse, element yerine boş bir alan veya başarısız bir istek alırsınız ve hata yalnızca tarayıcı konsolunda görünür.
Bir modal element, arkasındaki sayfanızı satır içi bir stille karartır. Satır içi stillere izin vermeyen bir style-src sayfayı karartılmamış bırakır, ancak modal yine de çalışır.

Başlamadan önce

İki şeye ihtiyacınız var:
  1. Bir accountId. biz_ önekli bir hesap kimliği veya kullanıcının kendi verileri için user_ önekli bir kullanıcı kimliği. Ödeme yüzeyleri bunun yerine bir plan veya tutar alır ve her element sayfası hangisine ihtiyaç duyduğunu belirtir.
  2. Bağladığınız elementlere kapsamlandırılmış bir erişim token’ı oluşturan bir sunucu uç noktası.
Bir Whop API anahtarını asla tarayıcı koduna koymayın. Anahtar token oluşturur, bu nedenle tarayıcının geliştirici araçlarını açan herkes hesabı okuyabilir. Token’ı sunucunuzda oluşturun ve yalnızca token’ı gönderin.
Sunucunuz, hesap ve elementlerin ihtiyaç duyduğu kapsamlarla Create Access Token uç noktasını çağırır:

Gereksinimler

Başlamadan önce

İki şeye ihtiyacınız var:
  1. Bir accountId. biz_ önekli bir hesap kimliği veya kullanıcının kendi bakiyesi için user_ önekli bir kullanıcı kimliği.
  2. Hesap için bir erişim token’ı oluşturan bir sunucu uç noktası. Uygulamada asla bir Whop API anahtarı yayımlamayın. Anahtar token oluşturur, bu nedenle onu çıkaran herkes hesabı okuyabilir. Token’ı sunucunuzda oluşturun ve yalnızca onu döndürün.
Bir user_… etiketi izleyicinin kendi verilerini okur, bu nedenle token yerine izleyici OAuth’unu (WhopSDK.configureWithOAuth) kullanır. Sohbet görünümleri de öyle.Sunucunuz, hesap ve elementlerin ihtiyaç duyduğu kapsamla Create Access Token uç noktasını çağırır:

Gereksinimler

Her iki iOS bağımlılık yöneticisi de çalışır. Paket hem bir ios/Package.swift hem de bir podspec içerir ve araç zinciri birini seçer. React Native’in Swift Package Manager otomatik bağlayıcısı Package.swift dosyasını tercih eder, bu nedenle zaten SPM kullanan bir uygulama podspec’ten etkilenmez. Bugün tüm Expo uygulamalarını içeren CocoaPods kullanan bir uygulama podspec üzerinden bağlanır ve başka hiçbir şeye ihtiyaç duymaz. SPM’de React Native alt sınırı daha yüksektir, çünkü Package.swift ilk kez 0.87’de yayımlanan, yalnızca başlık dosyası içeren iki XCFramework’ü bağlar.
Yerel kod, React Native Codegen ile üretilen Swift ve Kotlin’dir: burada hiçbir şey Objective-C veya Java’yı elle düzenlemenizi istemez ve kurulacak yerel eş bağımlılık yoktur.

Başlamadan önce

İki şeye ihtiyacınız var:
  1. Bir accountId. biz_ önekli bir şirket kimliği.
  2. O hesap için bir erişim token’ı oluşturan bir sunucu uç noktası. Uygulamada asla bir Whop API anahtarı yayımlamayın: anahtar token oluşturur, bu nedenle onu çıkaran herkes hesap adına işlem yapabilir. Token’ı sunucunuzda oluşturun ve yalnızca onu döndürün.
Sunucunuz Create Access Token uç noktasını çağırır ve sonucu getToken işlevine geri verir.

İlk elementinizi bağlayın

Eksiksiz bir uygulama. configure başlangıçta bir kez çalışır ve elementler o tamamlanana kadar bir yükleme göstergesi gösterir, böylece hiçbir şey onunla yarışmaz:
Eksiksiz bir ödeme. <WhopElements> token çözümleyicisini, <Payments> ücreti tutar ve aralarındaki elementler onu toplar:
Script etiketi yerine npm’i mi tercih ediyorsunuz? loadWhop() aynı barındırılan betiği ekler ve genel yapıcıyı çözümler:

Kimlik doğrulama

Tanıtıcıyı oluştururken bir accessToken iletin. Element başına bir token değil, tanıtıcının tamamı için tek bir token kullanın. Tanıtıcı bu token’ı altındaki her elemente gönderir, bu nedenle ihtiyaç duyduğunuz tüm kapsamları o tek token için isteyin. Her element sayfası okuduğu kapsamları listeler.
Token, SDK’nın çağırdığı bir geri çağırma değil, sizin ayarladığınız bir değerdir. Süresi dolmadan önce yenisini ayarlayın:
accessToken değerini atlarsanız, istekler bunun yerine izleyicinin oturum çerezini kullanır. Bu yalnızca whop.com üzerinde çalışır. API, kaynaklar arası ön kontrol isteklerinde Access-Control-Allow-Credentials göndermez, bu nedenle kendi alan adınızdaki bir sayfanın geri dönebileceği bir oturum yoktur ve bir token iletmesi gerekir.

Genel yapılandırma

Oluşturma sırasında ilettiğiniz her şey, o örnekten oluşturulan her element grubuna uygulanır (bir tanıtıcının kendi seçenekleri grup bazında geçersiz kılabilir):
Appearance
Her element için görsel özelleştirme: theme (açık/koyu + paletler), variables (CSS özel özellikleri) ve classes (parça başına stil bildirimleri). Renk şeması bir elementin ilk çiziminden önce uygulanır, bu nedenle koyu sayfalar asla açık renkte parlamaz. Görünüm sayfasına bakın.
string
Element arayüz metinleri için yerel ayar; uygulamanın derlenmiş yerel ayarlarından biri; diğer tüm değerler varsayılan yerel ayara geri döner. Varsayılan değer "en"."en", "es", "zh", "nl", "pt", "de", "hu", "it", "fr", "ja", "pl" veya "tr" değerlerinden biri.
"production" | "sandbox"
Elementlerin iletişim kurduğu Whop API ortamı; "sandbox" sandbox API’sini hedefler (test verileri; gerçek para hareket etmez). Bir ortam seçmek, elementlerin alıcının yazdıklarını nereye gönderdiğini değiştirmenin tek yoludur ve her iki ortam da Whop’a aittir. Sandbox ortamı henüz genel kullanıma açık değildir. Varsayılan değer "production".
boolean
Elementlerin sayfanızda bildirim (toast) gösterip gösteremeyeceği; sağ alt köşede gösterilen kısa durum mesajları (“Payment method added”, “Payment failed”). Tamamen kapatmak için false olarak ayarlayın. Varsayılan değer true.
boolean
Whop pikselini atlar. Varsayılan olarak elementler, Whop reklam pikselini henüz çalıştırmayan bir sayfaya, çalıştıkları hesaba (bir element grubunun accountId değeri veya bir ödemenin planının satıcısı) kapsamlandırılmış olarak yükler ve element analizlerini pikselin ziyaretçi kimliğine bağlar; bu, element etkinliğini Whop’un kimlik grafiğindeki reklam ilişkilendirme verilerinizle birleştirilebilir kılan tek seferlik bir kimlik bağlantısıdır. Bunların hiçbirini yapmamak için true olarak ayarlayın. Kullanım analizlerinin kendisi etkilenmez (bunları tanıtıcı bazında analytics: false ile kapatın). Varsayılan değer false.
React’te aynı nesne <WhopElements appearance={…} locale={…}> üzerinden iletilir.toasts genel ayarı bu sayfada canlıdır; aşağıdaki düğme, elementlerin kullandığı aynı kanal üzerinden, bu sayfanın appearance ayarıyla temalandırılmış bir bildirim gönderir:

Elementlerin üstlendikleri ve sizin sorumluluğunuzda olanlar

Her element kendi verilerini getirir ve kendi yükleme, boş ve hata durumlarını gösterir.Gezinme ve depolama sizin sorumluluğunuzdadır. Elementler seçimleri ve sonuçları olay olarak bildirir ve veritabanınıza asla yazmaz.İstisna, sayfadan ayrılan bir akıştır. Bir element returnUrl aldığında sekmeyi oraya yönlendirir, böylece alıcı sayfanızın dışına çıkabilir. Alıcı oraya başarılı bir site dışı adımdan sonra olduğu kadar başarısız veya yarıda bırakılmış bir adımdan sonra da, URL’ye status (succeeded, failed veya canceled) ve denemenin kimliği eklenmiş olarak ulaşır; bu nedenle returnUrl adresindeki sayfa bir başarı mesajı göstermeden önce status değerini okumalıdır. Teslimatı bir tarayıcı geri çağırması yerine webhook’lardan yapın.Elementler çerçevelerde çalışır, bu nedenle sınırı yalnızca serileştirilebilir değerler geçer. Paylaşılan bir DOM yoktur ve nesne kimliği korunmaz.

Sorun giderme

Kullanılabilir elementler

Payments

Bir plan_ kimliğinden veya satır içi para birimi ve tutardan ödeme toplayın ya da mode: "setup" ile ücret almadan bir ödeme yöntemi kaydedin.

Verifications

Bir hesap için kimlik bilgilerini toplar ve doğrular.

Checkout

Whop ödeme oturumları API’sine karşı bir veya daha fazla plan için eksiksiz, barındırılan bir ödemeyi yönetir: kalem kalem fiyat özeti, promosyon kodları, alıcının ödeme yaptığı para birimi ve ödeme toplama yüzeyinin tamamı (içine yerleştirilmiş ödeme elementleri).

Ads

Bir reklam hesabı.

Tracking

Bir hesabın izlenen kitlesi: pikselinin gördüğü herkes ve gerçekleştirdikleri her olay.

Wallet

Bir hesabın para yüzeylerini yönetir.

Websites

Bir hesabın web siteleri: whop.site üzerinde oluşturulan her site ve Whop Pixel’in bildirdiği her alan adı, alan adı başına trafik ve ilişkilendirilmiş gelirle birlikte.

Dashboard

Bir hesabın sitenize gömülü kendi kontrol paneli yüzeyleri.

Delivery

Bir işletme için müşteri teslimat takibi.

Chat

Kanal listesi ve mesaj aramasıyla gerçek zamanlı sohbet.

Sonraki adımlar

Kimlik doğrulama

getToken() tek entegrasyon noktanızdır ve SDK onu token’ın süresi dolmadan önce tekrar çağırır, bu nedenle önbelleğe almak yerine her seferinde yeni bir token döndürün:
Elementlerin üstünde herhangi bir yerde bir kez yapılandırın. WhopSDK işlem genelindedir, bu nedenle ikinci bir çağrı yalnızca hesap değiştiğinde gerekir:
Sohbet ve DM’ler bir hesap yerine izleyicinin kimliğini OAuth aracılığıyla doğrular: WhopSDK.configureWithOAuth(appId:).

Tema

.whopTheme(_:) SwiftUI ortamı boyunca yayılır, bu nedenle tek bir çağrı altındaki her elemente tema uygular. Her biri bir WhopTint olan altı rol:
Varsayılanlar accent: .blue, neutral: .gray, danger: .red, info: .sky, success: .green, warning: .amber şeklindedir. WhopTheme.default altısının tamamıdır. Görünümler sistemin açık/koyu görünümünü kendiliğinden izler.

Elementlerin üstlendikleri ve sizin sorumluluğunuzda olanlar

Her görünüm kendi verilerini getirir ve yeniden deneme dahil kendi yükleme, boş ve hata durumlarını gösterir. Gezinme sizin sorumluluğunuzdadır: seçim geri çağırmaları size bir değer verir ve asla bir ekran açmaz.

Sorun giderme

iOS’ta kullanılabilenler

Her birinin sayfasında canlı bir simülatör bulunan cüzdan görünümleri:İzleyici kimliği doğrulanmış sohbet için WhopChatView ve WhopDMsListView aynı pakette sunulur. README dosyasına bakın.

iOS’ta ödemeler

Ödeme elementleri, bir Elements modülü sunan kendi paketleri whopio/elements-swift üzerinden sunulur. Cüzdan SDK’sının modülü WhopElements olduğundan ikisi yan yana kurulur:
Modül WhopElements değil Elements olduğundan, değişen tek satır import Elements satırıdır. Kurulum da farklıdır ve SwiftUI’nin ayrıldığı şekilde ayrılır: yapılandırma uygulama kökünden devralınır ve tek bir ücret bir kapsamdır. Hiçbir şey token gerektirmez, çünkü bir onay token’ı alıcının yazdıklarından oluşturulur ve sunucunuzda onaylanır:
Kart verileri PCI yalıtımlı barındırılan girişler tarafından yakalanır ve asla sizin işleminize girmez. Her şeye .whopTheme(_:) yerine .whopElementsAppearance(_:) ile stil verin.

Kimlik doğrulama

getToken tek entegrasyon noktanızdır ve SDK onu her istekten önce çağırır, bu nedenle önbelleğe almak yerine yeni bir token döndürün:
Kimlik bilgisi gerektirmeyen bir element onsuz çalışır, böylece arka ucunuzu bağlamadan önce bir kart formu gösterebilirsiniz.

Ödeme alma

Toplama ve onaylama ayrıdır ve bu ayrım kasıtlıdır: uygulama asla bir kart numarası görmez ve sunucunuz asla istemciye güvenmez.
  1. Elementler toplar. Kart numaraları PCI yalıtımlı girişlerden doğrudan bir token’a gider, asla sizin kodunuzdan geçmez.
  2. createConfirmationToken(), kendi arka ucunuza göndermesi güvenli olan bir onay token’ı döndürür.
  3. Arka ucunuz ödemeyi Whop API’si ile onaylar.
  4. API, ödemenin alıcıdan daha fazlasına ihtiyaç duyduğunu yanıtlarsa, client_secret değerini handleNextAction() işlevine verin; SDK 3D Secure veya yönlendirme adımını çalıştırır.

Yönlendirmeler ve 3D Secure

Uygulama dışı adımlar asla bir WebView değil, sistem tarayıcısını (iOS’ta ASWebAuthenticationSession, Android’de Custom Tabs) açar; böylece kart çıkarıcının sayfası uygulamanızın güven sınırının dışında kalır ve çerezleri uygulamanızın çerez kavanozunun dışında kalır.<Payments> üzerindeki returnUrl değerini barındırdığınız bir https URL’sine ayarlayın. API, https veya loopback dışındaki her şeyi reddeder (PaymentsApi::ValidateReturnUrl), bu nedenle özel bir uygulama şeması burada çalışmaz; zaten buna ihtiyacınız da yoktur: handleNextAction, uygulamanıza geri dönen bir derin bağlantıyı beklemek yerine ödeme sonuçlanana kadar sorgular ve tarayıcıyı kendisi kapatır.

Apple Pay ve Google Pay

Cüzdan kutucukları, platform bir sayfa sunabildiğinde görünür ve ikisi için de ayarlanacak bir şey yoktur. Apple Pay, Whop hesabında kayıtlı satıcıyı kullanır, bu nedenle uygulamanızın bir satıcı tanımlayıcısına veya Xcode yeteneğine ihtiyacı yoktur. <Payments> üzerindeki googlePayMerchantName yalnızca sayfada gösterilen adı ayarlar.

Tema

<WhopElements> üzerindeki appearance, web elementlerinin aldığı aynı theme nesnesiyle altındaki her elemente tema uygular. Görünüm sayfasına bakın.

Elementlerin üstlendikleri ve sizin sorumluluğunuzda olanlar

Her element kendi verilerini getirir ve kendi yükleme, boş ve hata durumlarını gösterir. Gezinme ve gönderim sizin sorumluluğunuzdadır: elementler onChange aracılığıyla bildirir ve asla bir ekran açmaz veya arka ucunuzu çağırmaz.

Sorun giderme

React Native’de kullanılabilenler

Ödeme elementleri:
  • PaymentElement: yöntem kutucukları ve seçilen yöntemin ihtiyaç duyduğu her şey
  • AddressElement: alıcının kendi ülke biçiminde fatura adresi
  • CardElement: tek bir bileşen olarak numara, son kullanma tarihi ve güvenlik kodu
  • CardFields: aynı üç alan, ayrı ayrı yerleştirilmiş
  • EmailElement: alıcının e-postası
  • TaxIdElement: bir kayıt türü ve numarası
  • BrandingElement: her formda zorunlu olan Powered by Whop işareti
Ödeme (checkout) elementleri:
  • ExpressCheckoutElement: <Checkout> altında, ödemenin tamamını ödeyen tek bir Apple Pay veya Google Pay dokunuşu