Pinning seguro
Registre `X-DestrIA-SDK-Version`, `info.version` do OpenAPI e `release` do health/contract-check no mesmo artefato de deploy.
Try it out seguro
API Reference interativa para validar integrações reais.
A página carrega o contrato OpenAPI do ambiente atual, gera parâmetros e payloads de exemplo, executa chamadas autenticadas sob demanda e produz curl pronto para CI sem salvar sua API key.
Release 1.0.458
Matriz de compatibilidade dos artefatos públicos
Use esta matriz para fixar versões, configurar CI e garantir que OpenAPI, Postman, SDK, health e contract-check estejam sincronizados antes de liberar integrações de produção.
| Artefato | Fonte de versão | Gate obrigatório | Uso em produção |
|---|---|---|---|
| OpenAPI 3.1 | X-DestrIA-OpenAPI-Version (info.version + release) | openapi-version / openapi-version-header | Geração de clients, validação de payloads, diff de contrato e governança de breaking changes. |
| Postman | X-DestrIA-Postman-Version | postman-coverage / postman-version-header | Newman em CI, smoke tests de autenticação, headers RateLimit-* e regressão de endpoints públicos. |
| SDK TypeScript | X-DestrIA-SDK-Version | sdk-surface / sdk-version-header | Jobs, workers, integrações CRM, helpers cron, parsing de erros e observabilidade de rate limit. |
| Health | release | runtime / artifact URLs | Monitoramento sintético, status page interna, checagem de release e descoberta de artefatos públicos. |
| Contract-check | release + summary | contract-check pass | Portão único de compatibilidade entre OpenAPI, Postman, SDK, docs, rate limit e superfície pública. |
Quebra bloqueada
Se Postman divergir do OpenAPI, se o SDK perder símbolos públicos ou se docs não cobrirem compatibilidade, o contract-check falha.
Operação contínua
Health confirma URLs e release em produção; contract-check aprofunda consistência de contrato antes de rodar automações externas.
Selecione um endpoint para ver parâmetros, exemplos e execução.