Pular para o conteúdo

Changelog da API

Esta página registra o que muda na API: endpoint novo, campo novo, comportamento diferente.

Tipo de mudançaO que acontece
Campo novo numa respostaEntra em v1, sem aviso
Endpoint novoEntra em v1, sem aviso
Parâmetro opcional novoEntra em v1, sem aviso
Mudança que quebra — campo removido, formato alterado, parâmetro que vira obrigatórioAvisada aqui antes de entrar

A regra prática para o seu lado: ignore o que não conhece. Campo novo numa resposta não pode derrubar o seu código. Se o seu cliente valida a resposta contra um esquema fechado, deixe-o aberto para campos extras — é o jeito mais comum de uma integração quebrar sozinha numa terça-feira.

Bloco LGPD da captação — vale para landing pages, plugin do WordPress e o script dos sites Astro. Nada quebra: são campos e endpoints novos.

OndeO que mudou
CORS/public/api/v1/web_properties/* passou a aceitar chamada de navegador de qualquer origem. O caminho por caixa de entrada (/inboxes/{website_token}/...) continua fechado
LimitesTetos próprios da captação pública: landing page 120/h por IP; site cadastrado 10.000/h por IP e por token; visitas 300/h por IP; consentimento 60/h por IP na landing page. Excesso responde 429 — retentar com espera
Conversãopartial: true marca lead parcial (pré-coleta). O sufixo :parcial no identificador tem o mesmo efeito. Parcial cria o contato, nunca conta como conversão, e é substituído a cada novo envio da mesma pessoa no mesmo formulário
Conversãoconsent_level e consent_version gravados na conversão e no contato
Conversãocontact_id aceito no lugar de e-mail e telefone quando o contato já é conhecido
Novo endpointPOST /public/api/v1/web_properties/{token}/consent — prova de consentimento do banner: nível, versão do texto, página, navegador e IP truncado. Sem contato. Apagada em 5 anos

Detalhes em CORS, limites e eventos de conversão.

Não foi mudança de API — foi correção da documentação, e vale registrar porque muda o que você precisa saber.

As 31 páginas da API foram conferidas linha a linha contra o código. Onze delas descreviam comportamento que não existe. Se você montou integração seguindo a documentação anterior, confira estes pontos:

OndeO que a documentação diziaO que é
WebhookAssinatura HMAC, segredo por webhookNão há assinatura. A chamada leva só content-type e accept
WebhookAté 3 reentregas com recuoEntrega única. Falhou, o evento é descartado
WebhookEventos de negócio (deal_won, deal_lost…)Não existem. Funil se acompanha por automação do funil
Limites300/min por token, headers X-RateLimit-*3.000/min por IP, sem headers. O 429 vem em texto puro
AutenticaçãoVários tokens, com escopo e validadeUm token por usuário, sem escopo nem validade
Mensagens”Envio não é exposto via API”É exposto — POST /conversations/{id}/messages
Campos personalizadosTipos 0=texto, 2=lista, 3=data2=currency, 3=percent, 6=list
ConvençõesIdempotency-Key, meta.total_pagesNenhum dos dois existe

Detalhes em convenções, autenticação e segurança do webhook.

Hoje o aviso de mudança é esta página. Não existe e-mail automático de deprecation nem cabeçalho Sunset na resposta — se você leu isso em documentação nossa anterior, estava errado.

Se a sua integração é crítica, o mais seguro é acompanhar esta página antes de cada mudança grande do seu lado, e manter um teste seu que chame os endpoints que você usa e confira o formato da resposta. É mais barato que descobrir pelo suporte.

Abra um chamado com:

  • O endpoint, o corpo enviado e a resposta recebida
  • O que você esperava
  • Para pedido de endpoint novo: o que você está tentando fazer, não o endpoint que você imagina. Muita coisa já existe por outro caminho

Lembrando o escopo: a API cobre o dia a dia da operação. Configuração do CRM — criar funil, etapa, campo, automação — fica no painel de propósito. Veja introdução.