Introdução

Esta API permite mostrar detalhes adicionais do contato (restrições, crédito, gráfico, última compra, etc.) buscando em tempo real no sistema do cliente.

Como integrar à API

É necessário informar a URL de consulta no campo disponível na área de Integração de Detalhes do Contato, 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 onde a requisição será feita.
O token é uma chave de segurança do sistema do cliente onde a requisição será feita.
Toda URL deve conter o parâmetro token na querystring.

Requisições

O Zen fará uma requisição na URL_DO_CLIENTE fornecida enviando o parâmetro ID (Código de Integração).
Ao receber o parâmetro ID (Código de Integração), o sistema do cliente deve retornar os dados referentes ao contato solicitado no formato JSON exemplificado mais abaixo.

Exemplo de requisição do Zen para o sistema do cliente:

http://{URL_DO_CLIENTE}?token={TOKEN}&id={ID}	
    

Respostas

Todas as respostas deverão ser uma string JSON válida.

Exemplo de resposta bem-sucedida:
Ver Modelo

	
 {
   "Detalhes" : [{
		  "Descricao" : "",
		  "Itens"  :[
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""}
			    ]
		}],
   "Grafico" :  [{
		   "Descricao" : "",
		   "Tipo" : "",
		   "Itens"  :[
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""},
			      {"Titulo" :"", "Valor" : ""}
			    ]
		}]
 }
    

Obs.: O nó Itens da chave Detalhes pode conter até 30 itens.
Obs.2: O nó Itens da chave Gráfico pode conter até 12 itens.

Parâmetros Detalhes

Parâmetros Gráfico