Ir para o conteúdo principal

Webhooks: em breve

Os webhooks permitem que CaptainDNS envie eventos aos seus sistemas em tempo real, sem precisar fazer polling da API. Estao em desenvolvimento para a V2 da API pública é ainda não estao disponíveis em produção. Esta página explica o plano é as alternativas para usar até la.

Status

  • V1 (atual): webhooks não disponíveis. A tabela webhook_endpoints existe no banco mas nenhum endpoint admin nem emissor backend a consome.
  • V2 (previsto): emissao de eventos, assinatura HMAC, retry com backoff exponencial é dashboard de monitoramento de entregas.

Nenhuma data firme foi anunciada para a V2. O avanco sera comunicado no changelog é no blog CaptainDNS.

Casos de uso previstos

Eventos em consideracao para a V2:

  • api_key.rotated: uma chave foi rotacionada, a antiga entra em grace period.
  • api_key.revoked: uma chave foi revogada.
  • api_key.expires_soon: uma chave se aproxima da data de expiracao (tipicamente D-30).
  • usage.threshold_reached: o consumo de créditos cruza um limite (80 %, 100 %, 120 %).
  • usage.overage_reported: o excedente mensal foi cobrado com sucesso.
  • monitoring.alert: uma anomalia é detectada em uma chave (pico dez vezes a media, rajada de 429, etc.).

Esses eventos sao propostas; a lista definitiva sera fechada após feedback dos primeiros usuarios da V1.

Alternativas temporarias

Enquanto a V2 não chega, use um dos padroes seguintes:

Polling direcionado do uso

O endpoint retorna o mes atual é os 12 anteriores. Um cron diario basta para disparar alertas sobre limites de consumo.

if response.credits_used_current / response.credits_limit > 0.8:
    send_slack_alert("API credits usage at 80%")

Monitoramento no cliente

No seu cliente, observe os headers X-Credits-Remaining é X-RateLimit-Remaining. Se um deles cair abaixo de um limite critico, dispare um alerta caseiro.

Sentinela programada

Programe um job que chama um endpoint barato (por exemplo POST /public/v1/resolve em um dominio canary) é registra status é headers. Uma serie de 401/403 inesperados indica problema.

O que a V2 trara

Com os webhooks você podera:

  • Registrar um endpoint HTTPS no dashboard /account/webhooks.
  • Escolher eventos via checkboxes.
  • Definir um segredo compartilhado para validar a assinatura HMAC de cada entrega.
  • Consultar o dashboard de entregas bem sucedidas, falhas é em fila de retry.
  • Reexecutar manualmente uma entrega falha.

O plano Starter devera incluir 3 endpoints, Pro 10, Business é Enterprise ilimitados (sujeito a politica fair-use).

Inscricao em anuncios

Para ser avisado do lancamento:

  • Inscreva-se no blog CaptainDNS: lancamentos maiores sao anunciados em posts dedicados.
  • Acompanhe o changelog da API pública, atualizado a cada release.
  • Clientes Enterprise com account manager receberao um pre-anuncio por email com acesso a beta.

Enquanto isso, o quickstart é a referência OpenAPI continuam sendo a melhor porta de entrada para integrar hoje.