Démarrage
Copiez une invite de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/native-purchases`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/native-purchases/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
-
Installez le package
Fenêtre de terminal bun add @capgo/native-purchases -
Synchroniser avec les projets natifs
Fenêtre de terminal bunx cap sync -
Vérifier le support de facturation
import { NativePurchases } from '@capgo/native-purchases';const { isBillingSupported } = await NativePurchases.isBillingSupported();if (!isBillingSupported) {throw new Error('Billing is not available on this device');} -
Charger les produits directement des magasins
import { NativePurchases, PURCHASE_TYPE } from '@capgo/native-purchases';const { products } = await NativePurchases.getProducts({productIdentifiers: ['com.example.premium.monthly','com.example.premium.yearly','com.example.one_time_unlock'],productType: PURCHASE_TYPE.SUBS, // Use PURCHASE_TYPE.INAPP for one‑time products});products.forEach((product) => {console.log(product.title, product.priceString);}); -
Mettre en œuvre les flux d'achat et de restauration
import { NativePurchases, PURCHASE_TYPE } from '@capgo/native-purchases';const monthlyPlanId = 'monthly-plan'; // Base Plan ID from Google Play Consoleconst transaction = await NativePurchases.purchaseProduct({productIdentifier: 'com.example.premium.monthly',planIdentifier: monthlyPlanId, // REQUIRED for Android subscriptions, ignored on iOSproductType: PURCHASE_TYPE.SUBS,quantity: 1,});console.log('Transaction ID', transaction.transactionId);await NativePurchases.restorePurchases();- Créez des produits et des abonnements en application dans App Store Connect.
- Utilisez StoreKit Local Testing ou les testeurs de sandbox pour la QA.
- Aucune modification du manifeste requise. Assurez-vous que vos produits soient approuvés.
- Créez des produits et des abonnements en application dans Google Play Console.
- Téléchargez au moins une version de test interne et ajoutez des testeurs de licence.
- Ajoutez la permission de facturation à
AndroidManifest.xml:
<uses-permission android:name="com.android.vending.BILLING" /> - Créez des produits et des abonnements en application dans App Store Connect.
Exemple de service d'achat
Section intitulée « Exemple de service d'achat »import { NativePurchases, PURCHASE_TYPE, Transaction } from '@capgo/native-purchases';import { Capacitor } from '@capacitor/core';
class PurchaseService { private premiumProduct = 'com.example.premium.unlock'; private monthlySubId = 'com.example.premium.monthly'; private monthlyPlanId = 'monthly-plan'; // Base Plan ID (Android only)
async initialize() { const { isBillingSupported } = await NativePurchases.isBillingSupported(); if (!isBillingSupported) throw new Error('Billing unavailable');
const { products } = await NativePurchases.getProducts({ productIdentifiers: [this.premiumProduct, this.monthlySubId], productType: PURCHASE_TYPE.SUBS, });
console.log('Loaded products', products);
if (Capacitor.getPlatform() === 'ios') { NativePurchases.addListener('transactionUpdated', (transaction) => { this.handleTransaction(transaction); }); } }
async buyPremium(appAccountToken?: string) { const transaction = await NativePurchases.purchaseProduct({ productIdentifier: this.premiumProduct, productType: PURCHASE_TYPE.INAPP, appAccountToken, });
await this.processTransaction(transaction); }
async buyMonthly(appAccountToken?: string) { const transaction = await NativePurchases.purchaseProduct({ productIdentifier: this.monthlySubId, planIdentifier: this.monthlyPlanId, // REQUIRED for Android subscriptions productType: PURCHASE_TYPE.SUBS, appAccountToken, });
await this.processTransaction(transaction); }
async restore() { await NativePurchases.restorePurchases(); await this.refreshEntitlements(); }
async openManageSubscriptions() { await NativePurchases.manageSubscriptions(); }
private async processTransaction(transaction: Transaction) { this.unlockContent(transaction.productIdentifier); this.validateOnServer(transaction).catch(console.error); }
private unlockContent(productIdentifier: string) { // persist entitlement locally console.log('Unlocked', productIdentifier); }
private async refreshEntitlements() { const { purchases } = await NativePurchases.getPurchases({ productType: PURCHASE_TYPE.SUBS, }); console.log('Current purchases', purchases); }
private async handleTransaction(transaction: Transaction) { console.log('StoreKit transaction update:', transaction); await this.processTransaction(transaction); }
private async validateOnServer(transaction: Transaction) { await fetch('/api/validate-purchase', { method: 'POST', body: JSON.stringify({ transactionId: transaction.transactionId, receipt: transaction.receipt, purchaseToken: transaction.purchaseToken, }), }); }}Options d'achat requises
Section intitulée « Options d'achat requises »| Option | Plateforme | Description |
|---|---|---|
productIdentifier | iOS + Android | SKU/ID de produit configuré dans App Store Connect / Google Play Console. |
productType | Seulement Android | PURCHASE_TYPE.INAPP ou PURCHASE_TYPE.SUBS. Par défaut INAPP. Toujours défini sur SUBS pour les abonnements. |
planIdentifier | Abonnements Android | ID du plan de base du Google Play Console. Obligatoire pour les abonnements, ignoré sur iOS et pour les achats en application. |
billingPlanType | Abonnements iOS | Plan de facturation StoreKit pour l'achat. Utilisez 'monthly' pour un facturation mensuelle avec un engagement de 12 mois lorsque product.pricingTerms expose cette option. |
quantity | iOS | Seulement pour les achats en application, par défaut sur 1. Les appareils Android achètent toujours un article. |
appAccountToken | iOS + Android | __CAPGO_KEEP_0__ est un identifiant UUID liant l'achat à votre utilisateur. Obligatoire d'être UUID sur iOS ; Android accepte toute chaîne obfusquée jusqu'à 64 caractères. |
isConsumable | Android | Défini sur true pour consommer automatiquement les jetons après avoir accordé un droit pour les consommables. Défaut à false. |
Vérification de l'état des droits
Section intitulée « Vérification de l'état des droits »Utilisez getPurchases() pour une vue croisée de chaque transaction que les magasins signalent :
import { NativePurchases, PURCHASE_TYPE } from '@capgo/native-purchases';
const { purchases } = await NativePurchases.getPurchases({ productType: PURCHASE_TYPE.SUBS,});
purchases.forEach((purchase) => { if (purchase.isActive && purchase.expirationDate) { console.log('iOS sub active until', purchase.expirationDate); }
const isAndroidIapValid = ['PURCHASED', '1'].includes(purchase.purchaseState ?? '') && purchase.isAcknowledged;
if (isAndroidIapValid) { console.log('Grant in-app entitlement for', purchase.productIdentifier); }});Comportement du plateau
Section intitulée « Comportement du plateau »- iOS: Les abonnements incluent
isActive,expirationDate,willCancel, et le support de l'écouteur StoreKit 2. Les achats en application nécessitent la validation du reçu de serveur. - Android:
isActive/expirationDatene sont pas remplis; appelez le développeur Google Play API avec lepurchaseTokenpour le statut autoritaire.purchaseStatedoit êtrePURCHASEDetisAcknowledgeddoit êtretrue.
API référence rapide
Section intitulée “API référence rapide”isBillingSupported()– vérifiez la disponibilité de StoreKit / Google Play.getProduct()/getProducts()– récupérer le prix, le titre localisé, la description, les offres d'introduction et les termes de tarification iOS pris en charge.purchaseProduct()– initier la mise en œuvre de l'achat de StoreKit 2 ou du client de facturation, y compris les plans mensuels de facturation iOS.restorePurchases()– relier les achats historiques et synchroniser avec le dispositif actuel.getPurchases()– afficher toutes les transactions iOS ou les achats de facturation Play.manageSubscriptions()– ouvrir l'interface utilisateur de gestion des abonnements native.addListener('transactionUpdated')– gérer les transactions StoreKit 2 en attente lorsque votre application démarre (iOS uniquement).
Meilleures pratiques
Section intitulée « Meilleures pratiques »- Afficher le prix de la boutique – Apple exige de montrer
product.titleetproduct.priceString; ne jamais les coder en dur. - Utilisez
appAccountToken– générer de manière déterministe un UUID (v5) à partir de votre ID d'utilisateur pour lier les achats aux comptes. - Valider côté serveur – envoyer
receipt(iOS) /purchaseToken(Android) à votre backend pour la vérification. - Gérer les erreurs avec souplesse – vérifier les annulations de l'utilisateur, les échecs de réseau et les environnements de facturation non pris en charge.
- Tester soigneusement – suivre le guide du sandbox iOS et – suivre le guide du sandbox Android Guide de sandbox Android.
- Rétablissement et gestion des offres – ajouter des boutons d'interface utilisateur branchés à
restorePurchases()etmanageSubscriptions().
Étapes suivantes pour les revenus
Section intitulée « Étapes suivantes pour les revenus »Après que le flux de vente fonctionne, utilisez le Playbook des revenus pour planifier votre premier canal payant : portée du produit, ASO, tarification, placement de la barrière de paiement, analytics et feedback sur le taux de dérive.
Résolution des problèmes
Section intitulée « Résolution des problèmes »Produits non chargés
- Vérifiez que l'ID de l'ensemble / de l'ID de l'application correspond à la configuration de la boutique.
- Confirmez que les IDs de produits sont actifs et approuvés (App Store) ou activés (Google Play).
- Attendez plusieurs heures après avoir créé des produits ; la propagation de la boutique n'est pas instantanée.
Achat annulé ou bloqué
- Les utilisateurs peuvent annuler en cours de flux ; enveloppez les appels dans
try/catchet affichez des messages d'erreur amicaux. - Pour Android, assurez-vous que les comptes de test installent l'application depuis la boutique Play (piste interne) afin que la facturation fonctionne.
- Vérifiez logcat/Xcode pour les erreurs de facturation lors de l'exécution sur appareil.
État de l'abonnement incorrect
- Utilisez
getPurchases()pour comparer les données de la boutique avec votre cache de droits locaux. - Sur Android, interrogez toujours le développeur Google Play API avec
purchaseTokenobtenir les dates d'expiration ou l'état de remboursement. - Sur iOS, vérifiez
isActive/expirationDateet validez les reçus pour détecter les remboursements ou les révocations.