Skip to content
Guia da Central de Ajuda
4 min de leituraVerificado 2026-11-16

Exportação de dados e relatórios

Exporte listas filtradas por CSV manual, envios agendados por FTP/SFTP ou endpoints REST.

Neste guia

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

FLUXO DE ARQUITETURA
ARQUITETURA INTERATIVA
MOTOR DE EXPORTAÇÃO EM FLUXO E CONFORMIDADE
ETAPA 01 CAMADA DE PEDIDOS DE CLIENTE E AUTOMAÇÃO
Interface de Exportação
(Vistas de Tabela)
Tarefa Agendada BI/ERP
(x-api-key / Bearer)
Conformidade e Legal
(RGPD DSR e Audit.)
ETAPA 02 CONTROLADORES DE EXPORTAÇÃO PASSINSTANCE (API)
Exportações Operacionais (CSV UTF-8)
POST/api/v1/passes/export
GET/api/v1/validation/scans/*
GET/api/v1/dashboards/export
Exportações Financeiras e Legais
GET/api/v1/billing/invoices/*
POST .../data-subject-export
GET/api/v1/audit-log/export.csv
ETAPA 03 FORMATOS DE SAÍDA E DESTINOS
text/csv; charset=utf8
Linhas Escapadas 4180 (Passes, Leituras)
application/pdf
Faturas Discriminadas e Instantâneos Painel
application/json
Arquivos RGPD e
JSON do Painel

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 externalId e 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

Instâncias de Passes
POST
Caminho do Endpoint
/api/v1/passes/export
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Transmite linhas CSV (passes-export.csv) para uma lista explícita de até 2000 UUIDs (request payload: { passIds, format: "csv" }).
Histórico de Leituras da Configuração
GET
Caminho do Endpoint
/api/v1/validation/configs/:id/scans/export
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Exporta eventos de leitura e resgates de mecânicas delimitados a uma única ScannerConfiguration.
Leituras do Espaço de Trabalho
GET
Caminho do Endpoint
/api/v1/validation/scans/export
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Exporta o histórico de leituras de validação de todo o espaço de trabalho em todas as configurações.
Pista de Auditoria de Leituras
GET
Caminho do Endpoint
/api/v1/validation/scan-results/export/csv
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Pista de auditoria completa e granular dos resultados de leitura, incluindo decision, reasonCode, ID do operador e efeitos no saldo.
Chaves de Dispositivos de Leitura
GET
Caminho do Endpoint
/api/v1/validation/configs/:id/scanner-keys/export/csv
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Inventário de chaves de leitor emitidas, estados de emparelhamento, datas de expiração e metadados de telemetria de dispositivos.
Resumo do Painel
GET
Caminho do Endpoint
`/api/v1/dashboards/export?format=csv\
Verbo HTTP
json\
Formatos de Saída (Content-Type)
pdf`
Resultado de Tarefa em Lote
GET
Caminho do Endpoint
/api/v1/batch-processing/:id/result.csv
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Transfere linhas de saída processadas de uma tarefa assíncrona de criação ou atualização em lote.
Faturas de Faturação
GET
Caminho do Endpoint
/api/v1/billing/invoices/:id/download
Formatos de Saída (Content-Type)
application/pdf
Descrição
Transmite o PDF oficial da fatura fiscal/IVA discriminada para um ciclo de faturação específico.
Titular de Dados RGPD
POST
Caminho do Endpoint
/api/v1/customer/:customerId/privacy-settings/data-subject-export
Formatos de Saída (Content-Type)
application/json
Descrição
Gera um payload estruturado de portabilidade ao abrigo dos Artigos 15.º/20.º do RGPD (IDataSubjectExportPayload) correspondente a request payload.query.
Registo de Auditoria de Segurança
GET
Caminho do Endpoint
/api/v1/audit-log/export.csv
Formatos de Saída (Content-Type)
text/csv; charset=utf-8
Descrição
Exporta até 1000 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"):

HTTP
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
HTTP/1.1 200 OK
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="passes-export.csv"
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:

HTTP
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>
HTTP
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:

HTTP
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"
}
JSON
{
  "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

Documentação de produto e API relacionada

Pronto para lançar o seu primeiro programa de cartões Wallet?

Crie o seu espaço de trabalho, configure o seu modelo e teste um cartão real na Apple Wallet e Google Wallet antes de escalar.