CRM Zen

Distribuição de Lead (Saída) Versão 1.0


Introdução

Esta API integra os contatos do CRM Zen com os contatos do sistema do cliente. Quando houver alguma ação no Zen, nosso sistema manda automaticamente os dados para o sistema do cliente.


Obs.: Para saída de contato padrão, sem os dados da distribuição de lead, usar a API Contato (Saída). Clique aqui para ver a documentação


Como integrar à API

É necessário informar a URL de ação no campo disponível na área de Integração de Contatos (Saída), na seção de Integração do Zen (No topo do CRM Zen, clique no ícone de engrenagem e depois selecione Integração).

Exemplo de URL do cliente:


http://{URL_DO_CLIENTE}?token={TOKEN}

A URL_DO_CLIENTE é o endereço do sistema do cliente que receberá o POST.
O token é uma chave de segurança do sistema do cliente que receberá o POST.
Toda URL deve conter o parâmetro token na querystring.

 

Requisições

O Zen enviará um POST com os dados em formato JSON (Ver modelos abaixo) para a URL_DO_CLIENTE fornecida.


Respostas

Todas as respostas devem estar no formato JSON.
De modo geral, respostas bem sucedidas devem retornar o Código 200.

	
   {
	"Codigo" : "Número",
	"Mensagem" : "Descrição"
   }
Obs.: Caso ocorra alguma falha na requisição, uma fila será mantida e disponibilizada em um painel para novas tentativas.


Inserir contato

STRING JSON Padrão que será enviada por POST ao ser incluído um contato no CRM Zen:
Ver Modelo


Editar contato

STRING JSON Padrão que será enviada por POST ao ser editado um contato no CRM Zen:
Ver Modelo


Parâmetros (Inserir e Editar)

Parâmetro Tipo Tamanho Descrição
Acao String 10 Ação realizada (Inserir/Editar)
Por String 150 Email de quem realizou a ação
Compartilhamento String 15.000 Emails de usuários que podem ver o contato. Separados por vírgula.
(até 150 caracteres cada email)
Caso esteja vazio, o compartilhamento é com todos os usuários do sistema
Integracao String 50 Código de Integração do contato
Nome String 100 Apenas para Pessoa Física
Sobrenome String 120 Apenas para Pessoa Física
CPF String 11 Apenas para Pessoa Física. Sem pontos, barras ou traços
RG String 20 Apenas para Pessoa Física
Sexo String 1 F (Feminino) /M (Masculino). Apenas para Pessoa Física
Nascimento String 12 dd/mm/aaaa. Apenas para Pessoa Física
Razao String 120 Razão social. Apenas para Pessoa Jurídica
Fantasia String 120 Nome fantasia. Apenas para Pessoa Jurídica
CNPJ String 14 Apenas para Pessoa Jurídica. Sem pontos, barras ou traços
Tipo String 1 F (Física) /J (Jurídica)
Emails String 150 Emails (Até 5 emails com 150 caracteres cada)
Website String 180 Website
Endereco String 120 Endereço
Numero String 20 Número
Complemento String 50 Complemento
Bairro String 100 Bairro
Cidade String 100 Cidade
Estado String 80 Estado
CEP String 10 CEP
Pais String 80 País
Telefone-> Tipo String 20 Tipo do telefone (Tipos existentes: Residencial, Comercial, Celular, Residencial Fax, Fax, Nextel, Outros, Celular Vivo, Celular Oi, Celular Tim, Celular Claro, Celular Sercontel, Celular CTBC e Celular Conecta)
Telefone-> DDI String 4 DDI
Telefone-> DDD String 4 DDD
Telefone-> Telefone String 24 Número do telefone
Telefone-> Ramal String 20 Ramal
Redes String 120 Redes Sociais com 120 caracteres cada
Campos-> Título String 50 Título dos Campos Personalizados com 50 caracteres cada
Campos-> Valor String 100 Valor dos Campos Personalizados com 100 caracteres cada
Observacao String 500 Observação
Tag String 1000 Tags separadas por vírgula e com 50 caracteres cada
MotorLead Inteiro 1
Origem->Nome String 50 Nome da origem
Origem->Codigo String 50 Código da origem
Segmento->Nome String 100 Nome do segmento
Segmento->Codigo String 50 Código do segmento
TipoAutomacao->Nome String 100 Nome do Tipo de Automação
TipoAutomacao->Codigo String 50 Código do Tipo de Automação
Produto->Nome String 100 Nome do Produto
Produto->Codigo String 50 Código do Produto