Changelog da API

Histórico do contrato público em api.checkoutsentry.com/v1. Mudanças do painel da loja ficam no changelog dentro do app, não aqui.

v1.0.24 · Bloqueio por faixa de GMV

  • Quando a loja está blocked, /v1 responde 402 com error.code plan_upgrade_required. blocked_at vem em ISO-8601 completo, com plan e plans_url.
  • Durante upgrade_required a resposta de sucesso inclui o header de status do plano com upgrade_required e block_at. No aviso de Black Friday o header é bf_notice, sem data de pausa.
  • MCP e webhooks outbound pausam junto da /v1 quando a loja está blocked. A flag admin nasce ligada; desligar deixa só o painel e a /v1. Alertas por e-mail, GET /health, pixel e ingestão continuam.

v1.0.22 · Criticidade do subtipo por loja

  • criticidade em GET /checkouts, no detalhe e em GET /metrics/errors?group_by=subtype passa a ser o override da loja, ou o padrão da taxonomia quando não há override.
  • O filtro criticidade acompanha esse override. low na config da loja é Baixo explícito.
  • Sem subtipo, a criticidade de alerta e de has_critical_error continua na classificação macro da loja.

v1.0.21 · Subtipo de erro

  • GET /checkouts e GET /checkouts/{token} devolvem sub_error_type, criticidade (critico, medio, baixo) e rótulos pt/en.
  • A lista aceita error_type, sub_error_type e criticidade.
  • GET /metrics/errors aceita group_by=subtype (contagem de checkouts no snapshot, só tipos crítico/alerta da loja).
  • MCP: get_error_breakdown group_by=subtype; get_checkouts filtra e devolve subtipo e criticidade.

v1.0.20 · UTM nos checkouts

  • GET /checkouts e GET /checkouts/{token} devolvem utm_source, utm_medium, utm_campaign, utm_term e utm_content (nullable).
  • A lista aceita utm_source e utm_campaign (igualdade exata no valor last-seen do snapshot).
  • MCP: get_checkouts inclui os mesmos campos no detalhe; get_utm_breakdown agrega volume, valor e erros por fonte.

v1.0.19 · Status de serviço unknown

  • last_status e a série de health aceitam unknown quando a página de status do fornecedor não pôde ser lida.
  • unknown não é queda: o webhook alert.integration_status_change não dispara ao entrar nesse estado nem ao voltar para up.

v1.0.18 · Introduction: rate limit por plano

  • Introduction documenta rate limit por chave (RPM) com tabela Solo → Enterprise e média por segundo.
  • Limite aplicado continua sendo a janela de 60s; headers X-RateLimit-* e 429 RATE_LIMITED.

v1.0.17 · Introduction: paginação + diagrama

  • Introduction explica como paginar listas (next_cursor em checkouts; has_more/offset em alerts), com diagrama de uso.

v1.0.16 · Webhooks: payloads outbound + diagrama

  • Tag Webhooks deixa claro que documenta payloads POST enviados ao URL cadastrado em Desenvolvedores (não rotas da API de leitura).
  • Diagrama de sequência (SVG + Mermaid) no onboarding da seção.

v1.0.15 · Events removido

  • Removidos GET /events e GET /checkouts/{token}/events (tag Events e escopo events:read).
  • Use GET /checkouts e GET /checkouts/{token} para inteligência de checkout sem timeline de pixel.

v1.0.14 · Serviços Monitorados (/monitored-services)

  • Tag Integrations vira Serviços Monitorados; paths /integrations* → /monitored-services*.
  • Lista devolve data.monitored_services (antes data.integrations). Escopo continua integrations:read.
  • Summaries: detalhes do serviço monitorado; health-series = Health Series.

v1.0.13 · Metrics: remove funil; errors com from/to

  • GET /metrics/funnel removido do contrato e do runtime.
  • GET /metrics/errors documenta data.from, data.to e data.group_by (já retornados no runtime).

v1.0.12 · client_id na lista; lookup removido

  • GET /checkouts aceita client_id= (filtro exato no snapshot).
  • GET /checkouts/lookup removido — use email/client_id na lista ou GET /checkouts/{token}.

v1.0.11 · Filtro sku e title em GET /checkouts

  • Query sku= (exato) e title= (substring) filtram no snapshot denormalizado (line_item_skus / line_item_titles).
  • MCP get_checkouts aceita os mesmos parâmetros sku e title.

v1.0.10 · line_items (com SKU) em GET /checkouts

  • Lista e detalhe de checkouts passam a incluir line_items (title, quantity, price, image_url, sku, variant_title) a partir do carrinho do pixel.
  • Mesmo formato no detalhe GET /checkouts/{token}; MCP get_checkouts expõe line_items nos detalhes.

v1.0.9 · GET /me simplificado — só key.name

  • GET /v1/me passa a devolver em data apenas key.name (removidos shop, plan, key.id/prefix/env/scopes e api).

v1.0.8 · PII sem gate de plano; teto único de 20 chaves; rate limit RPM

  • PII (include_pii + checkouts:pii) deixa de exigir plano Growth+; qualquer plano com Developers habilitado pode usar o escopo.
  • Limite de chaves ativas passa a ser 20 para todos os planos (não varia mais por tier); o uso continua limitado por api.rpm.
  • GET /v1/me.api.pii_allowed passa a refletir liberação por escopo, não por tier (até 1.0.9, quando /me foi simplificado).

v1.0.7 · Copy mais clara dos webhooks outbound

  • Textos dos Webhooks explicam que enviamos uma notificação POST e onde cadastrar URLs em Desenvolvedores.
  • alert.probe_correlated_failure descrito como várias checagens de saúde falhando juntas (sem jargão de probe).

v1.0.6 · Docs unificadas, Webhooks e recovered só em /checkouts

  • Introduction do portal concentra autenticação, escopos, watchlist e LGPD (sem cards duplicados acima do Scalar).
  • Seção Webhooks na OpenAPI: envelope alert.*, HMAC e onde configurar em Desenvolvedores.
  • GET /recovered-checkouts sai da spec publicada — use GET /checkouts?status=recovered (runtime deprecated permanece).

v1.0.5 · Sem cota mensal — rate limit só por RPM

  • GET /v1/me deixa de expor api.requests_month; a cota mensal foi removida do contrato.
  • O limite de uso continua sendo o rate limit por minuto (api.rpm) conforme o plano.

v1.0.4 · Webhooks outbound v1 (HMAC por loja)

  • Entrega assinada com secret por loja; envelope api_version: v1 e eventos alert.*.
  • Até 2 endpoints em Developers (toggles, filtros, cadência alert_cadence|per_event, include_pii).
  • Retries 3× (~1m/5m/30m) com delivery_id/event_id; docs em docs/public-api/webhooks-outbound.md.

v1.0.3 · Unificação de checkouts, ordenação e isolamento

  • GET /v1/checkouts aceita status=recovered (substitui /recovered-checkouts, agora deprecated).
  • Query order=asc|desc nas listas (checkouts, events, alerts) e em /metrics/daily.
  • Respostas autenticadas com Cache-Control: private, no-store e Vary: Authorization.
  • Docs: fuso UTC vs BRT, exemplos type/bucket em /metrics/errors, e confirmação via GET /v1/me ao trocar chave.
  • Developers: texto do mint deixa explícito que a chave completa já vem com prefixo csk_.

v1.0.2 · Correção de métricas e docs mais claras

  • GET /v1/metrics/errors com group_by=type (padrão) volta a responder 200 — paridade com a RPC do dashboard.
  • Portal developers.checkoutsentry.com em português e inglês, com guia de autenticação e explicação da watchlist.
  • Em cada rota, o escopo aparece separado da descrição (**Escopo:**) e no security OpenAPI.
  • Botão Gerar chave abre o fluxo Developers no painel quando você já está logado.

v1.0.1 · Métricas de erros por bucket sem event_logs

  • GET /v1/metrics/errors?group_by=bucket usa a RPC dashboard_critical_errors_by_bucket (paridade com o dashboard).
  • Envelope e parâmetros da rota permanecem iguais; só a fonte de agregação muda.

v1.0.0 · API pública de leitura

  • Runtime em https://api.checkoutsentry.com/v1 com chaves csk_live_ e csk_test_.
  • Envelope { data, request_id } e o mesmo UUID no header X-Request-Id.
  • Respostas autenticadas incluem X-RateLimit-Limit e X-RateLimit-Remaining; 429 também envia Retry-After.
  • Recursos: identidade da chave, checkouts, métricas, recuperados, integrações, eventos e alertas (somente leitura).
  • PII (e-mail, telefone, nome e CEP) só com include_pii, escopo checkouts:pii e plano Growth+.
  • Spec OpenAPI em GET /v1/openapi.yaml; referência interativa em developers.checkoutsentry.com.