Seja bem-vindo à documentação da API de integração com o Luvik! Com nossa nova integração, você descobrirá como é fácil adicionar novos contatos ao CRM de forma rápida e eficiente.
Para integrar-se com a API do Luvik, é necessário gerar uma chave de autenticação. Para gerar sua chave, siga os passos abaixo:
1. Faça login na sua conta do Luvik.
2. No menu lateral, vá até a opção “Configurações”.
3. Acesse a aba “Integrações”.
4. Na página que se abrir, você verá todas as integrações disponíveis no Luvik.
5. Procure pela integração chamada “Integração com o CRM do Luvik”. Nela, você encontrará sua API key.
6. Essa API key deve ser usada em todas as requisições.
Para cadastrar um novo contato no CRM, deve ser feita uma requisição do tipo 'POST', para a url abaixo:
POST https://services.luvik.com.br/***?apiKey=${apiKey}
API key no cabeçalho da requisição.
POST: https://services.luvik.com.br/***
Headers: {
apiKey: ${apiKey}
}
No corpo da requisição, é necessário enviar um JSON contendo os campos necessários para cadastrar o novo contato. Dependendo do tipo de contato (Pessoa Física ou Pessoa Jurídica), um JSON personalizado deve ser enviado.
Observações sobre os Campos da Requisição
1. O campo 'type' deve indicar se o contato é uma pessoa física ou jurídica, sendo inserido como 'PF' ou 'PJ'
2. No campo 'document', deve ser inserido o CPF do contato em caso de pessoa física e o CNPJ em caso de pessoa jurídica.
3. Os campos 'legalResponsibleName', 'legalResponsibleDocument', 'corporateName', 'foundationDate' e 'birthDate' devem ser preenchidos apenas quando se trata de leads pessoa jurídica.
4. Os campos 'foundationDate' e 'birthDate' devem estar no formato 'AAAA-MM-DD'.
{
"legalResponsibleName"
:
"string"
,
"legalResponsibleDocument"
:
"string"
,
"corporateName"
:
"string"
,
"foundationDate"
:
"string"
,
"complement"
:
"string"
,
"neighborhood"
:
"string"
,
"observations"
:
"string"
,
"originLabel"
:
"string"
,
"utmCampaign"
:
"string"
,
"utmContent"
:
"string"
,
}
}
{
"complement"
:
"string"
,
"neighborhood"
:
"string"
,
"observations"
:
"string"
,
"originLabel"
:
"string"
,
"utmCampaign"
:
"string"
,
"utmContent"
:
"string"
,
}
}
5. No campo 'originLabel', deve ser passada uma etiqueta (label), como por exemplo 'INTEGRACAO_FACEBOOK'.
| Atributo | Descrição |
| id | ID do contato (string) |
| type | Tipo de Pessoa - FF ou PJ (string) |
| name | Nome do Contato (string) |
| document | Documento - Se PF CPF, Se PJ CNPJ (string) |
| legalResponsibleName | Nome do responsável pela empresa (string) |
| legalResponsibleDocument | Documento do responsável pela empresa (string) |
| corporateName | Razão Social da Empresa (string) |
| foundationDate | Data de fundação da empresa (string) |
| birthDate | Data de Nasacimento (string) |
| email | E-mail do Contato (string) |
| phone | Telefone do Contato (string) |
| whatsapp | WhatsApp do Contato (string) |
| state | Estado (Ex.: SP, MG, RJ) (string) |
| city | Cidade (Ex.: São Paulo, Belo Horizonte, Rio de Janeiro) (string) |
| street | Rua (Ex.: Rua do Contato) (string) |
| number | Número do Endereço (string) |
| complement | Complemento do Endereço (string) |
| neighborhood | Bairro do Endereço (string) |
| zipcode | CEP do Endereço (string) |
| details | Detalhes (string) |
| observations | Observações (string) |
| originLabel | Origem do Contato Enviar conforme exemplo: SITE, INTEGRACAO_FACEBOOK, MEU_SISTEMA_INTERNO (string) |
| tracking.utmSource | Tag UTM Source (string) |
| tracking.utmMedium | Tag UTM Medium (string) |
| tracking.utmCampaign | Tag UTM Campaign (string) |
| tracking.utmTerm | Tag UTM Term (string) |
| tracking.utmContent | Tag UTM Content (string) |
Para realizar a autenticação, a API key deve ser informada. Isso pode ser feito de duas maneiras:
POST https://services.luvik.com.br/api/v1/contacts?apiKey=${apiKey}
Criação de contato pelo RD Station
Acesse o RD Station Marketing, e no menu "Configurações" clique em "Integrações".
Na tela de "Integrações", clique em "Criar Webhook".
Preencha as informações conforme o exemplo abaixo:
https://services.luvik.com.br/api/v1/contacts/RDSTATION?apiKey=${apiKey}
A integração do RD Station com o Luvik acontecerá quando uma pessoa submeter um formulário criado no RD Station. O contato será criado no RD e, através do Webhook configurado, será enviado para o Luvik.
Lembre-se de substituir o exemplo ${apiKey} acima pela API Key gerada pelo Luvik
Criação de contato pelo GreatPages
Faça login no GreatPages e acesse as configurações do formulário (dê um clique no formulário e em seguida clique em "Configurar").
A integração do GreatPages com o Luvik acontecerá quando uma pessoa responder um formulário criado no GreatPages. O contato será criado no formulário do GreatPages e, através do Webhook configurado, será enviado para o Luvik.
Acesse “Configurar Integração”.
Selecione a opção “Webhook” e passe adiante clicando em “Continuar”.
Na próxima tela você precisará colar o link de autenticação gerado pelo Luvik em “URL da integração”, e selecionar a opção “POST+JSON”. Por último, passe adiante clicando em “Continuar” (não é preciso preencher o campo “token”).
https://services.luvik.com.br/api/v1/contacts/GREATPAGES?apiKey=${apiKey}
Lembre-se de substituir o exemplo ${apiKey} acima pela API Key gerada pelo Luvik
Na tela “Configurar campos” você precisará configurar as variáveis dos campos. Elas precisam ser exatamente iguais aos atributos disponíveis na tabela “Esquemas”, disponível no topo desta página.
Confira o exemplo abaixo:
Veja que, no formulário, o campo "Nome" corresponde a variável de integração "name", conforme a tabela: