Desenvolvedores

Política de versão e descontinuação da API.

A Chave Direta versiona a API pública no caminho da URL e nunca desliga uma operação sem 180 dias de aviso. Esta página é o contrato: é para ela que aponta o header Link rel="sunset" de toda resposta da API.

Atalhos

Falar com o time Entrar na plataforma Ver produto

Versionamento

A versão vive no caminho: /api/v1/public. A versão corrente é v1.

/api/public continua respondendo como alias sem versão e sempre aponta para a versão corrente. Ele existe por compatibilidade — para integrar, use o caminho versionado.

Toda resposta carrega API-Version: v1.

O que é uma mudança compatível

Estas mudanças acontecem sem aviso e sem trocar de versão:

Um campo novo, opcional, em uma resposta.
Um parâmetro novo, opcional, em uma requisição.
Um valor novo em um enum já documentado como extensível.
Uma operação nova.

Trate campos desconhecidos como ignoráveis: um cliente que quebra ao receber um campo a mais não está integrado corretamente.

O que exige aviso

Remover uma operação ou um campo, renomear qualquer coisa, restringir um formato aceito, ou trocar o significado de um valor existente. Nada disso acontece sem o processo abaixo.

Uma versão maior nova (/api/v2/public) nunca reaproveita um caminho existente: as duas versões convivem durante todo o período de aviso.

Como a descontinuação é anunciada

O aviso aparece em três lugares ao mesmo tempo, com no mínimo 180 dias de antecedência:

deprecated: true na operação, dentro de /openapi.json.
Header Deprecation (RFC 9745) na resposta da própria operação, com a data em que a descontinuação foi anunciada.
Header Sunset (RFC 8594) na mesma resposta, com a data em que a operação deixa de responder.

HTTP/2 200
API-Version: v1
Deprecation: Wed, 01 Jul 2026 00:00:00 GMT
Sunset: Mon, 28 Dec 2026 00:00:00 GMT
Link: <https://chavedireta.com.br/developers/deprecation>; rel="sunset"; type="text/html"

Enquanto nenhuma operação está descontinuada, não existe header Sunset com data — o que toda resposta carrega é o Link apontando para esta página.

Como se preparar

Leia Deprecation e Sunset nas respostas e registre um alerta quando aparecerem.
Releia /openapi.json periodicamente e compare os operationId com os que você usa.
Fixe o caminho versionado. Se você integrou pelo alias sem versão, migre.

Voltar à documentação

Dúvidas

Se uma descontinuação afeta a sua integração e o prazo não é suficiente, escreva para [email protected] antes da data de Sunset.