Pular para o conteúdo
Delivery API
Antes de planejar em torno de um recurso, confira o status dos recursos.

GuiasEngajamento

Formulários e leads

Crie formulários no Studio, renderize-os no seu site, bloqueie spam com o Turnstile e receba cada contato como um lead.

Esta página foi traduzida do inglês. Se houver qualquer diferença, vale a versão em inglês. Ler em inglês

Os formulários do Atlas coletam contatos no seu site e transformam cada um em um lead que a sua equipe pode atribuir, acompanhar e exportar. Os formulários funcionam no seu site de Development e, quando o Production está no ar, no seu site no ar.

  1. Crie o formulário no Studio. Campos, rótulos, texto de consentimento, rótulo do botão de envio e mensagem de sucesso, em Forms & leads.

  2. O seu site o renderiza. Ele busca a definição do formulário e desenha os campos com os próprios componentes, então o formulário combina com o seu design.

  3. O visitante envia. O navegador envia os dados diretamente ao Atlas. Nenhum token é usado: o Atlas só aceita requisições cujo Origin seja o endereço registrado do seu site.

  4. O Atlas verifica e armazena. Primeiro rodam as verificações de spam e abuso; depois o lead é salvo, enviado por e-mail à sua equipe e enviado aos seus webhooks.

Site de Development Site no ar (Production)
Quando respondem Sempre Quando o Production está ativado e há um release assinado no ar
Versão do formulário O último rascunho publicado A versão que está dentro do release no ar
Origem aceita Seus endereços de Development Somente https:// o seu domínio de Production
Onde os leads ficam Leads → Development Leads → Live website (“Leads from the live website”)
E-mails de leads Desativados por padrão Ativados por padrão; podem ser pausados

Os formulários seguem para o Production dentro dos releases, assim como as páginas. Um formulário que você altera em Development chega ao site no ar com o próximo release aprovado, e um formulário removido de um release deixa de responder ali.

Enquanto o Production está desativado, os endereços dos formulários dele respondem 404 CP_NOT_FOUND. Se o Production está ativado mas ainda não há um release assinado no ar, respondem 403 CP_PRODUCTION_LOCKED.

// GET /v1/public/environments/{environmentId}/forms/{formKey}
// → { key, name, version, fields, settings: { submitLabel, successMessage, consentText },
// challenge: { provider: 'turnstile', action, siteKey } }

Renderize os fields com os seus próprios inputs. Se challenge.provider for turnstile, renderize o widget Cloudflare Turnstile com o siteKey e a action informados e permita o Turnstile na sua Content-Security-Policy.

// POST /v1/public/environments/{environmentId}/forms/{formKey}/submissions
{
"idempotencyKey": "<new UUID per attempt>",
"sessionId": "<16–128 chars, A–Z a–z 0–9 _ ->",
"startedAt": 1761210000000, // when the visitor opened the form, in ms
"challengeToken": "<Turnstile token>",
"website": "", // hidden honeypot field; leave empty
"consent": true,
"fields": { "name": "…", "email": "…", "message": "…" }
}
Resposta Significado
201 { status: 'received' } Aceito. Mostre settings.successMessage
422 SUBMISSION_INVALID Um campo falhou na validação. Mostre os erros do campo
400 SUBMISSION_REJECTED Rejeitado, por exemplo por falha no desafio
429 Envios demais. Peça ao visitante que tente novamente mais tarde

Envios suspeitos são colocados em quarentena, mas ainda recebem 201, para que atacantes não descubram o que foi sinalizado.

  • Desafio Cloudflare Turnstile, por site.
  • Campo honeypot e tempo mínimo de preenchimento.
  • Detecção de duplicados em 10 minutos.
  • Limites de taxa por site, formulário, sessão do visitante e endereço IP. Veja Limites.

A aba Spam review no Studio mostra os envios em quarentena do Development. Os envios em quarentena do site no ar ainda não podem ser revisados no Studio.

O dono do site adiciona uma conexão de e-mail (SMTP ou um provedor de e-mail) em Integrations → Email. Senhas e chaves de API são armazenadas criptografadas e nunca são mostradas novamente nem registradas em log.

O cartão Email for enquiries and leads tem dois interruptores:

  • Live website: ativado por padrão quando o Production está no ar. Mude para “emails paused” para interromper os e-mails sem mexer nos formulários.
  • Development: desativado por padrão, para que envios de teste não enviem e-mail a ninguém. Os envios de teste são marcados com [Test].

Somente um administrador do site pode alterar esses interruptores. As respostas automáticas aos visitantes ficam desativadas, a menos que você as ative.