CRM Zen
Funil de Vendas

Consulta de dados por período do Funil de Vendas Versão 1.0


Introdução

Esta API recebe os parâmetros de período de consulta, filtro de data e filtro de origem de negócio, e retorna os dados deste período do Funil de Vendas.

Requisições

A URL e o token são gerados na área de Integração do Zen (No topo do CRM Zen, clique no ícone de engrenagem e depois selecione Integração).
Todas as requisições devem conter o parâmetro token (no header). E os parâmetros de consulta (na URL)
Os dados são uma string JSON válida. Ver modelos mais à frente.

Obs.: Cada requisição possui um período de espera. Uma requisição a cada 10 minutos

Obs.: O JSON deve ser encodado em UTF-8

Obs.: O token NÃO deve ser divulgado publicamente em hipótese alguma


Exemplo de requisição com PHP:

	
    $query = http_build_query([
      'filtro_data' => 1 até 5,
      'data_inicial' => 'YYYY-mm-dd',
      'data_final' => 'YYYY-mm-dd',
      'venda_direta' => 0 ou 1,
      'distribuicao_lead' => 0 ou 1,
      'canal_parceria' => 0 ou 1,
    ]);

    $token = 'Seu token';

    $ch = curl_init();
    $url = "{URL}";
    curl_setopt($ch, CURLOPT_URL,$url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        "token: {$token}",
    ));
    curl_setopt($ch, CURLOPT_URL, "$url?$query");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $retorno = curl_exec($ch); //VER MENSAGENS DE RETORNO PADRÃO
    curl_close($ch);
    


Respostas

Todas as respostas estarão no formato JSON;

Respostas bem sucedidas retornarão o código HTTP 200 OK e o JSON com os dados do Funil de Vendas;

E na ocorrência de erros, será retornado o código HTTP respectivo;

Sucesso

{
	"filtro_data": "Filtro da data",
	"data_inicial": "Data inicial da pesquisa",
	"data_final": "Data final da pesquisa",
	"venda_direta": "Valor para habilitar ou não o filtro pela   origem do negócio: Venda Direta",
	"distribuicao_lead": "Valor para habilitar ou não o filtro pela origem do negócio:
  Distribuição de Leads",
	"canal_parceria": "Valor para habilitar ou não o filtro pela origem do negócio:
  Canal Parceria",
	"usuarios": [
		{
			"nome": "Nome do usuário",
			"email_usuario": "Email do usuário",
			"negocios": "Quantidade total de negócios",
			"nao_qualificado": "Quantidade de negócios não qualificados",
			"cancelado": "Quantidade de negócios cancelados",
			"negocios_final": "Quantidade final de negócios (negocios - nao_qualificado - cancelado)",
			"valor_fechado": "Valor total dos Negócios Fechados",
			"etapas": [
				{
					"nome": "Nome da etapa",
					"quantidade": "Quantidade de negócios nesta etapa",
					"situacoes": [
						{
							"nome": "Nome da situação",
							"detalhes": [
								{
									"observacao": "Observação da situação",
									"valor": "Valor da situação"
								}
							],
							"categorias": [
								{
									"nome": "Nome da categoria",
									"detalhes": [
										{
											"observacao": "Observação da categoria",
											"valor": "Valor da categoria"
										}
									]				
								}
							]
						}
					]
				}			
			],
			"situacoes_negocio": [
				{
					"nome": "Nome da Situação do Negócio",
					"detalhes": [
						{
							"observacao": "Observação da Situação do Negócio",
							"valor": "Valor da Situação do Negócio"
						}
					],
					"categorias": [
						{
							"nome": "Nome da categoria",
							"detalhes": [
								{
									"observacao": "Observação da categoria",
									"valor": "Valor da categoria"
								}
							]				
						}
					]
				}
			]
		}
	]
}
			
Obs.: As "situacoes_negocio", "situacoes", "categorias", "detalhes", "observacao" e "valor" podem vir vazias.

Erros

{
    "error" : "Descrição do erro"
}
			

Mensagens de retorno

200 OK
  • Sucesso
400 Bad Request
  • O parâmetro "filtro_data" é necessário
  • O parâmetro "filtro_data" deve ser numérico!
  • Filtro de data inexistente! Consulte a documentação e veja os filtros disponíveis
  • O parâmetro "data_inicial" é necessário
  • Data inicial inexistente ou em formato inválido
  • O parâmetro "data_final" é necessário
  • Data final inexistente ou em formato inválido
  • A data inicial é posterior a data final!
  • O período máximo a ser consultado é de 7 dias!
  • É necessário selecionar pelo menos uma das origens!(Venda Direta, Distribuição de Lead ou Canal Parceria)
  • Apenas ´0´(não) e ´1´(sim), são permitidos nos parâmetros de origem!
401 Unauthorized
  • Token inválido
  • Token desabilitado
  • Token não informado
  • Acesso não autorizado
405 Method Not Allowed
  • O método utilizado não é permitido para este recurso
429 Too Many Requests
  • Você excedeu o número de requisições. Sua última requisição foi em "YYYY-mm-dd H:i:s". Sua próxima requisição estará disponível em "YYYY-mm-dd H:i:s"
500 Internal Server Error
  • Ocorreu um erro interno do servidor. Por favor, tente novamente.

Parâmetros

Parâmetro Tipo Tamanho Descrição
filtro_data Int 1 Filtro de data a ser utilizado. Disponíveis:
  • 1 - Começa: Traz os Negócios que iniciam nesse período.
  • 2 - Termina: Traz os Negócios que terminam nesse período.
  • 3 - Começa e Termina: Traz os Negócios que iniciam e terminam dentro do período.
  • 4 - Durante: Traz os Negócios que passam por este período.
  • 5 - Começa ou Termina: Traz os Negócios que iniciam ou terminam dentro do período.
data_inicial Date 10 Data inicial do período a ser consultado. Exemplo: 2018-01-01
data_final Date 10 Data final do período a ser consultado. Exemplo: 2018-01-01
venda_direta Int 1 0 - Desabilitado; 1 - Habilitado; Filtro pela origem do negócio: Venda Direta
distribuicao_lead Int 1 0 - Desabilitado; 1 - Habilitado; Filtro pela origem do negócio: Distribuição de Lead
canal_parceria Int 1 0 - Desabilitado; 1 - Habilitado; Filtro pela origem do negócio: Canal Parceria.