Funil de
Vendas
Consulta de dados por período do Funil de Vendas Versão 1.0Introduçã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çõesA 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
RespostasTodas 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 retorno200 OK
400 Bad Request
401 Unauthorized
405 Method Not Allowed
429 Too Many Requests
500 Internal Server Error
Parâmetros
|