Vue d'ensemble
La configuration d'un compte Passinstance initialise votre espace de travail locataire isolé, paramètre vos préférences régionales et vous guide à travers un pipeline d'intégration automatisé afin de générer des passes de démonstration prêts à être testés dans Apple Wallet et Google Wallet.
Pipeline d'onboarding & machine à états
Passinstance orchestre l'initialisation du compte via une machine à états automatisée OnboardingSession pilotée par Onboarding API :
Étapes d'onboarding & énumérations
La session progresse selon les valeurs exactes de l'énumération OnboardingStep :
-
1
WALLET_SETUP: consultez et acceptez les conditions d'émission de la plateforme (googleWalletAccepted) et préparez les identifiants de démonstration par défaut. -
2
PERSONALIZE: sélectionnez votre modèle métier et votre palier de volume mensuel estimé :
- EVALUATING : évaluation des fonctionnalités et exploration en bac à sable. - UP_TO_500 : boutiques indépendantes, clubs locaux, lieux spécialisés. - RANGE_500_5000 : commerces en croissance, salles de sport régionales, événements de taille moyenne. - RANGE_5000_25000 : franchises multi-sites et grandes associations d'adhérents. - RANGE_25000_PLUS / ENTERPRISE : billetterie à fort volume, fidélité retail nationale, cartes de transport ou compagnies aériennes.
-
3
GENERATING_DEMOS: le backend met en file d'attente des tâches en arrière-plan qui provisionnent des modèles de démonstration pour les catégoriesOnboardingUseCase(LOYALTY_AND_CUSTOMER_CARDS,MEMBERSHIP_CARDS,TICKETING,VOUCHERS_OR_COUPONS,GIFT_CARDS_OR_PREPAID_CARDS,BUSINESS_CARDS,EMPLOYEE_IDS,INSURANCE_WARRANTY_AND_SERVICE_CARDS,OTHER). -
4
TRY_PASS: génère un passe échantillon éphémère accompagné d'un QR code scannable pour une installation immédiate sur mobile. -
5
DONE: l'onboarding se termine et débloque l'ensemble du tableau de bord d'administration (/dashboard).
Référence API du contrôleur d'onboarding
Les développeurs et scripts de provisionnement automatisés peuvent piloter l'onboarding par programmation sous /api/v1/onboarding :
| Chemin d'endpoint | Méthode | Auth | Charge utile / Paramètres | Description |
|---|---|---|---|---|
/api/v1/onboarding | GET | Bearer | Aucun | Récupère l'état courant de la session d'onboarding, l'étape active et les démos générées. |
/api/v1/onboarding/wallet-setup | PUT | Bearer | { "googleWalletAccepted": true } | Accepte les conditions d'émission Wallet et provisionne la configuration Google Wallet par défaut. |
/api/v1/onboarding/personalize | PUT | Bearer | { expectedPassVolume, useCases: [] } | Enregistre le palier de volume métier et les éléments OnboardingUseCase sélectionnés. |
/api/v1/onboarding/demos | POST | Bearer | Aucun | Déclenche la génération asynchrone des modèles de démonstration (QUEUED -> READY). |
/api/v1/onboarding/demos | GET | Bearer | Aucun | Interroge l'avancement de la génération des démos pour les cas d'usage demandés. |
/api/v1/onboarding/demos/:type/retry | POST | Bearer | Paramètre d'URL :type | Relance la génération d'un modèle démo si un type du catalogue a échoué. |
/api/v1/onboarding/sample-pass | POST | Bearer | { templateId? } | Génère un passe de test en direct pour une installation Wallet immédiate. |
/api/v1/onboarding/sample-pass/public/:sessionId | GET | Aucune | Paramètre d'URL :sessionId | Endpoint public non authentifié pour afficher/installer le passe échantillon sur mobile. |
/api/v1/onboarding/complete | POST | Bearer | { skipSamplePass?: boolean } | Marque la session d'onboarding comme DONE. |
Liste de contrôle de configuration du compte
Suivez ces étapes clés dans Passinstance Dashboard pour préparer votre espace de travail à la mise en production :
-
1
Vérifier votre espace de travail et votre e-mail : confirmez votre adresse e-mail dès l'inscription (toute adresse e-mail valide est acceptée) pour établir vos identifiants d'administrateur locataire, préconfigurés avec un certificat Apple démo et un émetteur Google Wallet géré.
-
2
Configurer les paramètres régionaux : rendez-vous dans Settings -> General (
/settings/workspace/general) ou appelezPUT /api/v1/customer/:customerId/regional-settingspour définir :
- Fuseau horaire : évalue les plafonds journaliers de scan et les horodatages locaux (ex. Europe/Berlin, America/New_York). - Devise : définit la devise ISO 4217 par défaut pour les soldes prépayés (ex. EUR, USD, GBP). - Langue par défaut : définit la langue principale des champs Wallet localisés.
-
3
Configurer le certificat Apple Wallet (Production) : dans Settings -> Wallet -> Apple Certificates (
/settings/workspace/wallet), générez une demande de signature de certificat viaPOST /api/v1/certificates/generate-csr, téléversez-la sur l'Apple Developer Portal sous Pass Type IDs, puis importez le fichier.cersigné viaPOST /api/v1/certificates. -
4
Configurer l'émetteur Google Wallet (Production) : sous Settings -> Wallet -> Google Wallet, lancez l'initialisation (
POST /api/v1/google-wallet/setup) et consultez le statut (GET /api/v1/google-wallet/status) pour vérifier votre Google Issuer ID et votrecollectorIdSmart Tap. -
5
Rôles d'équipe & contrôle d'accès : sous Settings -> Access -> Members & Roles (
/settings/workspace/access), invitez vos collaborateurs avec les rôles d'organisation (OrganizationMemberRole:OWNER,ADMIN,MEMBER) associés aux rôles RBAC d'espace de travail (DEFAULT_ROLES:super-admin,admin,editor,user,customer) et activez l'authentification à deux facteurs (enforceTwoFactorAuth).
Prérequis : Pour émettre des passes en production à votre propre marque dans Apple Wallet, vous devez disposer d'un abonnement actif à l'Apple Developer Program (99 $/an) afin de générer un certificat Apple Pass Type ID (
pass.com.yourcompany.app). Les tests effectués dans le bac à sable d'onboarding utilisent les certificats de démonstration Passinstance.
Consultez nos Tarifs et paliers de capacité disponibles ou passez directement à la Phase 2 : Concevoir votre carte.
