Visão geral
O Passinstance disponibiliza dois motores complementares de automatização no Painel (/workflows, /automations e /settings/workspace/integrations):
-
1
Motor de Fluxos de Trabalho (
Workflow Engine APIem/api/v1/workflows): Máquinas de estado DAG orientadas a eventos apoiadas por workflow trigger type (29 tipos de acionadores), workflow action type (25 tipos de ações),IF_CONDITIONeDELAY. -
2
Automatizações Universais (
Automations APIem/api/v1/automations): Regras orientadas por políticas para comércio eletrónico e PassFlow compatíveis comExistingCardPolicy(REUSE_AND_UPDATE,ISSUE_ADDITIONAL,REPLACE,NO_OP, etc.) eConflictResolutionPolicy(ALLOW_ALL,RUN_ALL,HIGHEST_PRIORITY,BEST_OFFER,FIRST_MATCH,EXCLUSIVE,EXCLUSIVE_BY_SCOPE).
Pré-requisitos: A criação ou modificação de fluxos via
POST /api/v1/workflowsrequer permissões de edição de modelos (templates:manage) e pelo menos um Modelo de Cartão publicado. Os fluxos recém-criados iniciam emDRAFTouINACTIVEaté serem ativados emPOST /api/v1/workflows/:workflowId/activate.
Pipeline de Execução de Fluxos
Gerir Fluxos de Trabalho via REST (Workflow Engine API)
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /api/v1/workflows | Lista fluxos do espaço de trabalho (filtráveis por status em workflow status: DRAFT, ACTIVE, PAUSED, INACTIVE, ARCHIVED, ERROR). |
| POST | /api/v1/workflows | Cria um novo fluxo utilizando request payload (name, trigger, actions, conditions, tags). |
| GET | /api/v1/workflows/:workflowId | Obtém a definição do fluxo, histórico de execuções (/:workflowId/executions) e registos (/:workflowId/logs). |
| PUT | /api/v1/workflows/:workflowId | Atualiza acionadores, condições, ações ou status (request payload). |
| POST | /api/v1/workflows/:workflowId/activate | Ativa um fluxo de imediato (deactivate pausa a execução; trigger executa manualmente). |
| DELETE | /api/v1/workflows/:workflowId | Elimina um fluxo e cancela tarefas agendadas em atraso. |
Acionadores Suportados (workflow trigger type)
O enum Passinstance database workflow trigger type define todos os 29 tipos canónicos de acionadores de fluxo:
| Categoria de Acionador | Valores workflow trigger type | Quando É Disparado |
|---|---|---|
| Ciclo de Vida Cartão & Modelo | PASS_CREATED, PASS_UPDATED, PASS_SCANNED, PASS_VOIDED, PASS_DELETED, PASS_DOWNLOADED, TEMPLATE_CREATED, TEMPLATE_UPDATED | Imediatamente quando um cartão ou modelo é criado, alterado, lido, anulado, eliminado ou transferido. |
| Wallet, Mecânicas e Opt-In | PASS_INSTALLED, PASS_REMOVED, USER_OPT_IN, USER_OPT_OUT, POINTS_UPDATED, TIER_CHANGED, BALANCE_CHANGED, EVENT_EXPIRED, PASS_INACTIVE, SCAN_PERFORMED | Quando o registo em dispositivo Apple/Google Wallet muda, o consentimento altera ou limites de pontos/patamar/saldo são atingidos. |
| Utilizador, Faturação e Agenda | USER_REGISTERED, USER_LOGIN, USER_PROFILE_UPDATED, SUBSCRIPTION_CHANGED, PAYMENT_RECEIVED, PAYMENT_FAILED, WEBHOOK_RECEIVED, API_CALL, SCHEDULED, MANUAL, CUSTOM_API_EVENT | Em eventos de utilizador/pagamento, receção de webhooks de entrada (POST /api/v1/workflows/webhook/:customerId/:workflowId), agendamentos cron (normalizados ao fuso horário do espaço) ou execuções manuais/API. |
Exemplo: Criar um Fluxo de Seguimento para Subida de Patamar (POST /api/v1/workflows)
request payload aceita um objeto principal trigger e um array ordenado actions (IWorkflowActionConfig[]), juntamente com conditions, dataMapping, maxRetries (predefinição 3) e timeout (predefinição 300 segundos):
{
"name": "Gold Tier Upgrade Celebration & Companion Voucher",
"description": "Sends congratulatory push and waits 1 hour before issuing bonus drink voucher",
"trigger": {
"type": "TIER_CHANGED",
"filters": {
"templateId": "tmpl_loyalty_01"
}
},
"conditions": {
"field": "pass.tier",
"operator": "EQUALS",
"value": "GOLD"
},
"actions": [
{
"type": "SEND_PUSH_NOTIFICATION",
"name": "Gold Upgrade Alert",
"config": {
"message": "Welcome to Gold Tier! Enjoy 2x points on every visit."
}
},
{
"type": "DELAY",
"name": "Wait 60 Minutes",
"config": {
"durationMinutes": 60
}
},
{
"type": "GENERATE_ADDITIONAL_PASS",
"name": "Issue Companion Voucher",
"config": {
"targetTemplateId": "tmpl_gold_welcome_drink",
"linkToParentPass": true
}
}
],
"tags": ["loyalty", "gold-tier"]
}
Explore todos os tipos de ações em Operações Automatizadas de Cartões e orquestração visual em /workflow-engine.
