Ir para o conteúdo principal
CaptainDNS
✦NOVO·Status pages ligadas aos seus monitors. White-label, domínio personalizado, RSS, assinantes.Ver demo ao vivo

Changelog da API pública

Esta página lista as mudancas maiores da API pública CaptainDNS. Adicoes não destrutivas (novos endpoints, campos opcionais) sao documentadas aqui sem aviso formal. Breaking changes sao anunciados com pelo menos 30 dias de antecedencia via esta página e por email aos detentores de chaves ativas.

Politica de versionamento

  • Compatibilidade para tras: adicionar campos opcionais e novos endpoints não quebra clientes existentes.
  • Depreciacoes: um campo ou endpoint depreciado permanece funcional por pelo menos 6 meses após o anuncio.
  • Quebras: breaking changes sao anunciados com 30 dias de antecedencia e implantados em uma URL versionada (por exemplo /public/v2/*). A URL V1 continua operando durante o período de migracao.
  • Identificador de versao: a especificacao OpenAPI carrega seu proprio número (info.version). O número maior segue a URL versionada, o menor segue as adicoes retro compativeis.

Versao 0.3.1 - 2026-05-19

Adicionado

  • POST /public/v1/dmarc/validate: resposta enriquecida com scoring e recomendacoes. Novos campos opcionais aditivos: state, score, score_band, verdict_headline, verdict_sub, score_factors, score_breakdown, recommendations, passed_checks, parsed_tags. O contrato existente (DMARCAnalysis no nivel raiz) e estritamente preservado. Custo inalterado (1 credito), scope inalterada (mail:read).

Versao 0.3.0 - 2026-04-14

Modificado

  • Payload webhook: agora com schema_version: "2". Novos campos event_id, delivery_id, attempt. User-Agent agora CaptainDNS-Webhook/2.0.
  • Novos cabeçalhos em cada POST: X-CaptainDNS-Event-ID, X-CaptainDNS-Delivery-ID, X-CaptainDNS-Attempt (formato n/6), X-CaptainDNS-Event-Type. Os cabeçalhos existentes X-CaptainDNS-Signature e X-CaptainDNS-Timestamp permanecem inalterados.
  • Política de tentativas: se seu endpoint retornar 5xx, 408, 429 ou um timeout/erro de rede, 6 tentativas são feitas com backoff 10s, 1min, 10min, 1h, 6h, 24h. As demais respostas 4xx vão direto para failed_permanent sem nova tentativa.
  • event_id estável em todas as tentativas e reenvios manuais: chave de deduplicação recomendada no receptor.

Versao 0.2.0 - 2026-04-09

Adicionado

  • 51 endpoints publicos sob /public/v1/* cobrindo DNS, email, web e texto:
    • DNS: resolve, resolve/propagation, dnssec/check, ip/whois, ip/nslookup, ip/netmask, rdap/lookup, domain/dns-check.
    • Email: spf/lookup, spf/validate, dkim/lookup, dkim/validate, dmarc/lookup, dmarc/validate, dmarc/generate, dmarcbis/check, dmarcbis/migrate, dmarc/report/analyze, bimi/lookup, bimi/validate, bimi/logo/lookup, mta-sts/lookup, tls-rpt/lookup, dane/lookup, blacklist/ip, smtp/check, mail/header-audit, mail/header-analyze, mail/domain-check, deliverability/score, certificates/csr/parse, certificats/bimi/parse, certificats/bimi/lookup.
    • Web: url/check, page/crawl-check, phishing/check.
    • Texto: text/lower, text/upper, text/stats, text/slug, text/base64/encode, text/base64/decode, text/password/generate, text/urlencode, text/urldecode, text/json/format, text/json/to-yaml, text/yaml/format, text/yaml/to-json, text/hash, text/regex/test.
  • Gestão de chaves API pela dashboard CaptainDNS: listar, criar, revogar, rotacionar e consultar uso.
  • Esquema OpenAPI PublicAPIError com 10 códigos canonicos para todos os erros.
  • Header Idempotency-Key estilo Stripe, replay 24 horas, 409 IDEMPOTENCY_CONFLICT em body divergente.
  • Headers X-Credits-Limit/Remaining/Consumed retornados em toda resposta bem sucedida.
  • Headers RateLimit-Policy, X-RateLimit-Limit, X-RateLimit-Remaining (este último é emitido apenas em caso de recusa 429).
  • Header X-Request-Id retornado em toda resposta para facilitar o suporte.
  • 5 planos de cobranca: Free, Starter, Pro, Business, Enterprise com cotas e excedente por tier.
  • Cobrança de excedente opt-in com teto orçamentário mensal configurável pela dashboard.
  • Notification channels (webhooks, Slack) no dashboard do perfil, com assinatura HMAC-SHA256 opcional e 22 tipos de eventos. Veja a página dedicada.

Não entregue na V1

  • Webhooks da API pública assinados por chave (tabela webhook_endpoints) para enviar os eventos da sua conta aos seus sistemas.

Fique atualizado

  • Blog CaptainDNS: as releases maiores sao publicadas em artigos dedicados em captaindns.com/pt/blog.
  • Email: os detentores de chaves ativas recebem uma notificacao automatica para qualquer breaking change.
  • Esta página: toda adicao ou correcao e registrada aqui, em ordem cronologica inversa.
  • Especificacao OpenAPI: o campo info.version e incrementado a cada release. Monitorar seu valor permite disparar regeneracoes automaticas de SDK.

Proximo passo: volte ao quickstart para comecar a integrar, ou explore a referencia OpenAPI para ver todos os esquemas em detalhe.