Passar para o conteúdo principal

Integração com a API Ramper Marketing - Formulários - Javascript

Como integrar um formulário de contato ao Ramper Marketing via API em Javascript, com classes dos campos, campo de tracking, script e códigos de erro.

Escrito por Vinicius Poleti

Para integrar um formulário de contato com a API do Ramper Marketing por meio de Javascript, siga os passos abaixo.

1. Prepare os campos do formulário

Insira na propriedade class dos elementos do formulário: api-lahar e lahar_[nome_campo_integracao].

Nome:  <input class="api-lahar lahar_nome_contato" type="text" id="campo_nome" value="">
Email: <input class="api-lahar lahar_email_contato" type="text" id="campo_email" value="">

2. Adicione o campo hidden de tracking

Para o funcionamento correto do lead tracking com os leads que converterem nesse formulário, adicione:

<input type="hidden" name="identificador_tracker_lahar" id="identificador_tracker_lahar" value="">

3. Campos personalizados

Se o campo a integrar for personalizado, use o token do campo para identificá-lo:

Qual sua idade? <input class="api-lahar lahar_uNuQarKCor" type="text" id="campo_idade" value="">

Observação: se o campo personalizado for do tipo caixa suspensa, o valor informado deve existir como uma das opções do campo.

4. Insira o script na página

Adicione o script antes da tag </body> e substitua: ID_DO_FORMULARIO_COM_AS_INFOS (id do form), TOKEN_DA_API_LAHAR_OBTIDO_EM_CONFIGURACOES (token em Configurações), NOME_DO_FORMULARIO_PARA_IDENTIFICACAO (identificador da conversão) e ENDERECO_REDIRECIONAMENTO (URL de redirecionamento após a conversão).

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="https://scripts.lahar.com.br/api_parametros.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() {
  var integrou = false;
  $("#ID_DO_FORMULARIO_COM_AS_INFOS").submit(function() {
    if (!integrou) { efetua_integracao(); integrou = true; return false; }
  })
});
function efetua_integracao() {
  var campos = {
    token_api_lahar: 'TOKEN_DA_API_LAHAR_OBTIDO_EM_CONFIGURACOES',
    nome_formulario: "NOME_DO_FORMULARIO_PARA_IDENTIFICACAO",
    identificador_tracker_lahar: $('#identificador_tracker_lahar').val(), // remover se nao usar Tracking
    url_origem: $(location).attr('href')
  };
  var elementos = [];
  $('.api-lahar').each(function(index, element) { elementos.push(element); });
  integracao_js(campos, 'redireciona', elementos, 'conversions');
}
function redireciona() {
  var form = document.getElementById("ID_DO_FORMULARIO_COM_AS_INFOS");
  form.submit();
}
</script>

Códigos de retorno de erro da API

  • 101 – E-mail de notificação não enviado, porém o lead foi incluído com sucesso.

  • 102 – Não é possível obter conversões via GET; use POST.

  • 103 – Não é possível obter o estágio dos leads via GET; use PUT.

  • 104 – Não é possível atualizar atividades via GET; use PUT.

  • 105 – Não é possível enviar e-mails do BPM via GET; use POST.

  • 401 – Acesso não autorizado: token não identificado.

  • 404 – Erro imprevisto.

  • 520 – Limite da cota de contatos excedido.

  • 540 – Erro na inclusão do contato. O ambiente está ativo?

  • 541 – Erro na atualização de estágio do lead. O ambiente está ativo?

  • 550 – Nenhum campo recebido na requisição.

  • 551 – Campo obrigatório duplicado.

  • 552 – Envio não contempla os campos obrigatórios.

  • 553 – Erro de validação de campo.

  • 554 – Contato enviado não existe.

  • 555 – Conversão via telefone não possível: nenhum contato identificado.

  • 556 – Conversão não realizada: lead não deu consentimento.

  • 557 – Categoria de nota inválida.

  • 600 a 609 – Parâmetros não fornecidos ou inconsistentes (token, modelo, posição, destinatário, dados, secret key).

  • 620 – Acesso inválido ou e-mail não existente.

Ainda tem dúvidas?

É só entrar em contato com o nosso time de Suporte pelos canais:

  • Chat: disponível dentro do software, acessando sua conta em Perfil > Atendimento via Chat. O atendimento ocorre em dias úteis (calendário de São Paulo), das 9h às 12h e das 13h às 18h.

Respondeu à sua pergunta?