Proteside Docs
Referência de endpointsRelatórios PCI

Relatório PCI de um período (JSON, PDF ou CSV)

GET
/reports/pci

Reutiliza o snapshot mais recente do mesmo período exato; caso contrário, gera um snapshot on_demand. format=pdf responde 302 Location: <signed URL, 1 h> (ou os bytes do PDF quando o arquivo ainda não está no storage); format=csv transmite a tabela escolhida. regenerate=true força um novo snapshot e exige reports:generate. Organizações que não são parceiras precisam de um plano com relatórios de compliance (403 plan_limit).

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.

Parâmetros de consulta

org_id?string

Somente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.

Formatouuid
store_id*string
Formatouuid
period_start?string

Padrão: period_end − 7 dias

Formatodate-time
period_end?string

Padrão: agora. Intervalo máximo de 366 dias.

Formatodate-time
format?string
Padrão"json"
Valor em"json""pdf""csv"
csv_table?string
Padrão"scripts"
Valor em"scripts""headers""alerts"
locale?string
Padrão"pt-BR"
Valor em"pt-BR""en"
regenerate?boolean
Padrãofalse

Corpo da resposta

Snapshot (json) ou CSV

  1. response
id?string
Formatouuid
store_id?string
Formatouuid
kind?string
Valor em"weekly""on_demand""monthly"
period_start?string
Formatodate-time
period_end?string
Formatodate-time
locale?string
Valor em"pt-BR""en"
schema_version?integer
sha256?string|null
generated_by?string
has_pdf?boolean
csv_tables?array<string>
created_at?string
Formatodate-time
generated?boolean

true when this request generated the snapshot

data?

Report data schema_version 2: meta, scope, summary_643, summary_1161, scripts[], headers[], alerts[], policies[], periodic_checks[], data_access[]

curl -X GET "https://example.com/reports/pci?store_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "f1a2b3c4-9999-4000-8111-222233334444",  "store_id": "0c1d2e3f-1111-4222-8333-444455556666",  "kind": "on_demand",  "period_start": "2026-09-20T10:00:00.000Z",  "period_end": "2026-09-27T10:00:00.000Z",  "locale": "pt-BR",  "schema_version": 2,  "sha256": "9c1e…",  "generated_by": "api:ps_live_AbCdEfGhIjKlMnOpQrStUvWx",  "has_pdf": true,  "csv_tables": [    "scripts",    "headers",    "alerts"  ],  "created_at": "2026-09-27T10:12:00.000Z",  "generated": true,  "data": {    "meta": {      "report_id": "f1a2b3c4-…",      "store": "Loja do João",      "domain": "lojadojoao.com.br",      "schema_version": 2    },    "summary_643": {      "total": 21,      "authorized": 18,      "blocked": 1,      "needs_review": 2,      "expired": 0    },    "summary_1161": {      "events": 91234,      "alerts_total": 12,      "alerts_open": 1    },    "scripts": [],    "headers": [],    "alerts": [],    "policies": [],    "periodic_checks": [],    "data_access": []  }}