Visão Geral
O Passinstance disponibiliza endpoints de exportação de dados em fluxo contínuo em todos os domínios operacionais principais — incluindo instâncias de passes (POST /api/v1/passes/export), históricos de leituras de validação, chaves de dispositivos de leitura, relatórios executivos do painel de controlo, faturas fiscais de IVA, arquivos de titulares de dados do RGPD e registos de auditoria de conformidade (GET /api/v1/audit-log/export.csv ou no Painel de Controlo em /settings/workspace/developer/audit-logs). Todas as exportações estão estritamente delimitadas ao seu espaço de trabalho autenticado (Customer) e são transmitidas com cabeçalhos MIME padrão para consumo imediato por software de folhas de cálculo, pipelines de ERP ou sistemas SIEM.
Arquitetura de Exportação de Dados Multidomínio
Importante: Os ficheiros CSV e JSON exportados contêm frequentemente Dados Pessoais (PII) dos titulares de passes, tais como nomes, endereços de e-mail, valores
externalIde históricos de transações. Armazene e elimine sempre as exportações transferidas em conformidade com as políticas de retenção de Privacidade de Dados e RGPD da sua organização.
Catálogo Completo de Endpoints de Exportação
/api/v1/passes/exportContent-Type)text/csv; charset=utf-8passes-export.csv) para uma lista explícita de até 2000 UUIDs (request payload: { passIds, format: "csv" })./api/v1/validation/configs/:id/scans/exportContent-Type)text/csv; charset=utf-8ScannerConfiguration./api/v1/validation/scans/exportContent-Type)text/csv; charset=utf-8/api/v1/validation/scan-results/export/csvContent-Type)text/csv; charset=utf-8decision, reasonCode, ID do operador e efeitos no saldo./api/v1/validation/configs/:id/scanner-keys/export/csvContent-Type)text/csv; charset=utf-8Content-Type)/api/v1/batch-processing/:id/result.csvContent-Type)text/csv; charset=utf-8/api/v1/billing/invoices/:id/downloadContent-Type)application/pdf/api/v1/customer/:customerId/privacy-settings/data-subject-exportContent-Type)application/jsonIDataSubjectExportPayload) correspondente a request payload.query./api/v1/audit-log/export.csvContent-Type)text/csv; charset=utf-81000 linhas imutáveis de atividade administrativa (suporta action, entityType, userId, startDate, endDate, customerId).Exemplos de Utilização da API
1. Exportação CSV de Instâncias de Passes (POST /api/v1/passes/export)
Consulte os UUIDs de passes correspondentes através de GET /api/v1/passes ou POST /api/v1/passes/query-builder e, em seguida, transmita-os como passes-export.csv através de POST /api/v1/passes/export (request payload requer entre 1 e 2 000 UUIDs em passIds e "format": "csv"):
POST /api/v1/passes/export HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
Content-Type: application/json
{
"passIds": [
"55a19c88-102b-4f33-8d99-ccddff001122",
"77b20d99-304c-4a11-9e00-112233445566"
],
"format": "csv"
}
Cabeçalhos de Resposta e CSV Transmitido (200 OK)
HTTP/1.1 200 OK
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="passes-export.csv"
id,serialNumber,externalId,status,walletPlatform,activeRegistrations,firstName,email,tier,pointsBalance,createdAt
55a19c88-102b-4f33-8d99-ccddff001122,PI-2026-994812,CRM-88210,ACTIVE,APPLE_WALLET,2,Elena,elena@example.com,GOLD,1450,2026-10-14T09:15:22.000Z
77b20d99-304c-4a11-9e00-112233445566,PI-2026-994815,CRM-88219,ACTIVE,GOOGLE_WALLET,1,Marcus,marcus@example.com,GOLD,980,2026-10-18T14:40:05.000Z
2. Exportações CSV da Pista de Auditoria de Leituras e do Registo de Auditoria de Segurança
Exporte resultados de leituras ou pistas de auditoria administrativa para reconciliação financeira e de conformidade:
GET /api/v1/validation/scan-results/export/csv?startDate=2026-11-01T00:00:00.000Z&endDate=2026-11-16T23:59:59.999Z&decision=SUCCESS HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
GET /api/v1/audit-log/export.csv?startDate=2026-11-01T00:00:00.000Z&endDate=2026-11-16T23:59:59.999Z HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
3. Exportação de Portabilidade de Titular de Dados RGPD (request payload)
Quando um titular de passe submete um Pedido de Acesso de Titular de Dados (DSAR) verificado, transmita uma única query de pesquisa de 3 a 256 caracteres (como endereço de e-mail, número de série ou externalId) para Privacy Compliance API:
POST /api/v1/customer/cus_89a12b34-56c7-4d89-9e01-23456789abcd/privacy-settings/data-subject-export HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
Content-Type: application/json
{
"query": "elena@example.com"
}
{
"exportedAt": "2026-11-16T10:34:10.000Z",
"workspaceId": "cus_89a12b34-56c7-4d89-9e01-23456789abcd",
"queryLength": 17,
"totalCount": 2,
"groups": [
{
"resourceType": "passes",
"items": [
{
"id": "55a19c88-102b-4f33-8d99-ccddff001122",
"identifier": "PI-2026-994812",
"createdAt": "2026-10-14T09:15:22.000Z",
"updatedAt": "2026-11-16T08:42:11.000Z",
"source": "api",
"processingPurpose": "loyalty_program",
"retentionStatus": "ACTIVE",
"relatedResourceIds": ["scn_019331f4-8e2a-7b00-9c11-44a8e2019b3c"]
}
]
}
]
}
Documentação Relacionada
-
Consulte os códigos de decisão de leitura em Relatórios de Leitura e Resgate.
-
Transfira faturas fiscais em Faturas e Histórico de Faturação.
-
Saiba mais sobre retenção automatizada de dados e apagamento em Privacidade de Dados e RGPD.
