Visão geral
A configuração de uma conta Passinstance inicializa o seu espaço de trabalho tenant isolado, define as preferências regionais e guia-o através de um pipeline automático de integração (onboarding) para gerar passes de demonstração prontos a testar para a Apple Wallet e Google Wallet.
Pipeline de integração e máquina de estados
A Passinstance gere a inicialização da conta através de uma máquina de estados automatizada OnboardingSession suportada pelo Onboarding API:
Etapas e enums de integração
A sessão transita exatamente pelos valores do enum OnboardingStep:
-
1
WALLET_SETUP: Rever e aceitar os termos de emissão de carteiras da plataforma (googleWalletAccepted) e preparar as credenciais de demonstração predefinidas. -
2
PERSONALIZE: Selecionar o modelo de negócio e o patamar de volume mensal previsto:
- EVALUATING: Testes de funcionalidades e exploração em sandbox. - UP_TO_500: Lojas locais, clubes locais, recintos especializados. - RANGE_500_5000: Retalhistas em crescimento, ginásios regionais, eventos médios. - RANGE_5000_25000: Franchisings multi-localização e grandes associações de sócios. - RANGE_25000_PLUS / ENTERPRISE: Bilhética de elevado volume, fidelização de retalho nacional, passes aéreos/de transporte.
-
3
GENERATING_DEMOS: O backend coloca em fila tarefas em segundo plano que provisionam modelos de demonstração nas categoriasOnboardingUseCase(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: Gera um passe de amostra efémero com código QR legível para instalação imediata no telemóvel. -
5
DONE: A integração termina e desbloqueia todo o painel administrativo (/dashboard).
Referência da API do Onboarding Controller
Programadores e scripts automatizados de provisionamento podem conduzir a integração programaticamente em /api/v1/onboarding:
| Caminho do endpoint | Método | Autenticação | Payload / Parâmetros | Descrição |
|---|---|---|---|---|
/api/v1/onboarding | GET | Bearer | Nenhum | Obtém o estado atual da sessão de integração, etapa ativa e demonstrações geradas. |
/api/v1/onboarding/wallet-setup | PUT | Bearer | { "googleWalletAccepted": true } | Aceita os termos de emissão de carteiras e provisiona a configuração predefinida da Google Wallet. |
/api/v1/onboarding/personalize | PUT | Bearer | { expectedPassVolume, useCases: [] } | Guarda o patamar de volume empresarial e os itens OnboardingUseCase selecionados. |
/api/v1/onboarding/demos | POST | Bearer | Nenhum | Despoleta a geração assíncrona de modelos de demonstração (QUEUED -> READY). |
/api/v1/onboarding/demos | GET | Bearer | Nenhum | Consulta o progresso de geração das demonstrações para os casos de uso pedidos. |
/api/v1/onboarding/demos/:type/retry | POST | Bearer | Parâmetro URL :type | Repete a geração de modelo de demonstração caso um tipo específico do catálogo tenha falhado. |
/api/v1/onboarding/sample-pass | POST | Bearer | { templateId? } | Gera um passe de teste ativo para instalação imediata na carteira. |
/api/v1/onboarding/sample-pass/public/:sessionId | GET | Nenhuma | Parâmetro URL :sessionId | Endpoint público não autenticado para visualizar/instalar o passe de amostra em dispositivo móvel. |
/api/v1/onboarding/complete | POST | Bearer | { skipSamplePass?: boolean } | Marca a sessão de integração como DONE. |
Lista de verificação da configuração de conta
Siga estes marcos no Passinstance Dashboard para preparar o seu espaço de trabalho para o lançamento em produção:
-
1
Verificar espaço de trabalho e e-mail: Confirme o seu endereço de e-mail após o registo (qualquer endereço de e-mail válido funciona) para estabelecer as credenciais administrativas do tenant, pré-configuradas com um certificado Apple de demonstração e um emissor Google Wallet gerido.
-
2
Configurar definições regionais: Aceda a Definições -> Geral (
/settings/workspace/general) ou chamePUT /api/v1/customer/:customerId/regional-settingspara configurar:
- Fuso horário: Avalia limites diários de leitura e registos horários locais (ex.: Europe/Berlin, America/New_York). - Moeda: Define a moeda ISO 4217 predefinida para saldos pré-pagos (ex.: EUR, USD, GBP). - Idioma predefinido: Define o idioma principal para campos localizados da carteira.
-
3
Configurar certificado Apple Wallet (Produção): Em Definições -> Carteira -> Certificados Apple (
/settings/workspace/wallet), gere um Pedido de Assinatura de Certificado (CSR) viaPOST /api/v1/certificates/generate-csr, carregue-o no Apple Developer Portal em Pass Type IDs e importe o ficheiro.cerassinado viaPOST /api/v1/certificates. -
4
Configurar emissor Google Wallet (Produção): Em Definições -> Carteira -> Google Wallet, execute a configuração (
POST /api/v1/google-wallet/setup) e verifique o estado (GET /api/v1/google-wallet/status) para inspecionar o seu Google Issuer ID ecollectorIddo Smart Tap. -
5
Perfis da equipa e controlo de acessos: Em Definições -> Acessos -> Membros e Perfis (
/settings/workspace/access), convide colaboradores com funções organizacionais (OrganizationMemberRole:OWNER,ADMIN,MEMBER) juntamente com perfis RBAC do espaço de trabalho (DEFAULT_ROLES:super-admin,admin,editor,user,customer) e imponha a Autenticação de Dois Fatores (enforceTwoFactorAuth).
Pré-requisitos: Para emitir passes de produção com marca personalizada na Apple Wallet, é necessário ter uma subscrição ativa no Apple Developer Program ($99/ano) para gerar um certificado Apple Pass Type ID (
pass.com.yourcompany.app). Os testes na sandbox durante a integração utilizam certificados de demonstração da Passinstance.
Consulte os nossos Planos e patamares de capacidade ou avance diretamente para a Fase 2: Desenhar o seu passe.
