Loja ASSIST — API versioning and deprecation policy

Política de versionamento e descontinuação da API pública da Loja ASSIST. Esta página explica como identificar a versão em uso, acompanhar mudanças de contrato e reagir a limites de acesso. A v1 está ativa e não tem encerramento anunciado.

Acesso e rate limits

A API pública de catálogo aceita 300 requisições por endereço IP em cada minuto UTC, compartilhadas entre /api, /api/v1 e os endpoints atendidos pelo handler de catálogo. Cada requisição, inclusive HEAD e erros, consome uma unidade. O contador é compartilhado entre as instâncias do serviço; clientes na mesma rede podem compartilhar o mesmo limite. A consulta continua anônima, sem chave de API. A navegação da loja, seus formulários e APIs internas mantêm os contratos existentes.

As respostas anunciam RateLimit-Policy: "catalog";q=300;w=60 e RateLimit: "catalog";r=299;t=45: q é a quota, w a janela em segundos, r o saldo após a requisição e t os segundos restantes até o próximo minuto. São Structured Fields conforme draft-ietf-httpapi-ratelimit-headers-11, ainda um Internet-Draft, não um RFC publicado. Os campos separados RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset são fornecidos para compatibilidade; Reset também é um intervalo em segundos, não um timestamp Unix.

Ao esgotar o limite, o serviço responde HTTP 429, application/problem+json, code rate_limit_exceeded e Retry-After em segundos. Aguarde o intervalo antes de tentar novamente e reduza a concorrência. Requisições bloqueadas não prolongam a janela. HTTP 503 indica indisponibilidade temporária, inclusive do contador; nesse caso, respeite Retry-After. Os cabeçalhos não garantem que uma requisição futura será aceita: outras requisições do mesmo IP podem consumir o saldo. Respostas da API usam no-store para não compartilhar saldos entre clientes por cache.

O contador operacional guarda somente um identificador derivado por HMAC, sem armazenar o IP em texto claro. Entradas inativas há mais de 24 horas são removidas em lotes durante o tráfego subsequente. Não há cobrança por essas consultas nem promessa de disponibilidade contratual nesta API pública.

API versioning — versionamento e compatibilidade

A versão principal está no caminho /api/v1. O contrato de referência é OpenAPI da Loja ASSIST. Correções e alterações compatíveis permanecem na v1; a remoção ou mudança incompatível de operações, parâmetros ou tipos exige uma nova versão principal. Os clientes devem usar os operationIds e schemas publicados. A versão do pacote CLI tem seu próprio ciclo de lançamento.

Deprecation policy — política de descontinuação e Sunset

A v1 está ativa. Não há depreciação ou data de encerramento anunciada. Por isso suas respostas não enviam cabeçalhos Deprecation ou Sunset. O link HTTP rel="deprecation" aponta para esta política, conforme RFC 9745.

Quando uma versão for descontinuada, a ASSIST publicará aqui a versão afetada, a alternativa e as instruções de migração. A resposta afetada anunciará Deprecation como Structured Field Date, no formato @<segundos Unix>, conforme RFC 9745. Se houver uma data efetiva de desligamento, Sunset usará HTTP-date em GMT conforme RFC 8594; essa data não poderá preceder a depreciação. A data e o período de transição serão definidos no anúncio. Não há prazo mínimo de suporte contratado por esta política.

Recursos e atendimento

Atualizada em 8 de setembro de 2026.

Navegação