CRM Zen

Totais de Distribuição de Leads por usuários Versão 1.0


Introdução

Esta API recebe como parâmetro uma data (YYYY-mm-dd), e retorna os totais da distribuição de leads referente aos dados recebidos do dia por usuários, contendo: origem, segmento, automação, produtos/serviços e erros.

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 o parâmetro data (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 5 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(['data' => 'yyyy-mm-dd']);
    $token = 'Seu token';

    $ch = curl_init();
    $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 leads;

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

Sucesso

{
    "data": "Data de pesquisa",
    "usuarios": [
        {
            "nome": "Nome do usuário",
            "total_lead": "Quantidade total de leads",
            "origem": [
                {
                    "codigo": "Código de origem",
                    "nome": "Nome de origem",
                    "quantidade": "Quantidade de leads com origem"
                }
            ],
            "segmento": [
                {
                    "codigo": "Código do segmento",
                    "nome": "Nome do segmento",
                    "quantidade": "Quantidade de leads com segmento"
                }
            ],
            "automacao": [
                {
                    "codigo": "Código de automacao",
                    "nome": "Nome de automacao",
                    "quantidade": "Quantidade de leads com automacao"
                }
            ],
            "produtos_e_servicos": [
                {
                    "codigo": "Código de produtos e servicos",
                    "nome": "Nome de produtos e servicos",
                    "quantidade": "Quantidade de leads com produtos e servicos"
                }
            ]
        }
    ],
    "erros": {
        "com_erro": "Quantidade de leads com erro",
        "sem_agrupamento": "Quantidade de leads sem agrupamento",
        "limite_de_contatos": "Quantidade de leads que excederam o limite de contatos",
        "duplicados": "Quantidade de leads duplicados"
    }
}
Obs.: A "origem", "segmento", "automacao", "produtos_e_servicos" e "erros" podem vir vazios.

Erros

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

Mensagens de retorno

200 OK
  • Sucesso
400 Bad Request
  • O parâmetro "data" é necessário
  • Data inexistente ou em formato inválido
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
Data String 10 Data dos leads a serem recuperados. Exemplo: 2018-01-01