Leads por Usuário

Consulta de Leads por Usuário Versão 1.0

Introdução

Esta API recebe três parâmetros: data_inicial (YYYY-mm-dd), data_final (YYYY-mm-dd) e pagina (Numérico). A mesma retorna todos os usuários com os seus leads.

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 1 minuto

Obs.: A consulta possui uma paginação de 50 registros por requisição.

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_inicial' => 'YYYY-mm-dd',
        'data_final' => 'YYYY-mm-dd',
        'pagina' => 1,
      ]
    );

    $token = 'Seu token';

    $ch = curl_init();
    $url = "https://devphp.crmzen.com.br/api/leads_usuario/";
    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

{
    "paginacao" : {
        "pagina_atual": "Página atual da API",
        "total_paginas": "Quantidade total de páginas do retorno da API",
        "quantidade_registros_consulta": "Quantidade de registros retornados na consulta",
        "limite_registros_por_pagina": "Limite de registros consultados por página",
    },
    "usuarios": [
        {
            "nome": "Nome do usuário",
            "email": "E-mail do usuário",
            "leads": [
                {
                    "id_registro": "Linha do registro",
                    "codigo": "Código do Lead",
                    "data_entrada": "Data que o Lead entrou no sistema",
                    "data_redistribuicao": "Data de repique do Lead",
                    "origem": [
                        {
                            "codigo": "Código da origem",
                            "nome": "Nome da origem"
                        }
                    ],
                    "segmento": [
                        {
                            "codigo": "Código do segmento",
                            "nome": "Nome do segmento"
                        }
                    ],
                    "automacao": [
                        {
                            "codigo": "Código da automação",
                            "nome": "Nome da automação"
                        }
                    ],
                    "produtos_e_servicos": [
                        {
                            "codigo": "Código dos produtos e serviços",
                            "nome": "Nome dos produtos e serviços"
                        }
                    ]
                }
            ]
        }
    ]
}

Obs.: A "origem", "segmento", "automacao" e "produtos_e_servicos" podem vir vazios.

Erros

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

Mensagens de retorno

200 OK

Sucesso

400 Bad Request

O parâmetro "data_inicial" é necessário!
O parâmetro "data_final" é necessário!
Data inexistente ou em formato inválido!
O parâmetro "pagina" dever ser numérico!
O parâmetro "pagina" dever ser positivo!
O período máximo a ser consultado é de 7 dias!

401 Unauthorized

Token inválido
Token desabilitado
Token não informado
Acesso não autorizado

404 Not Found

Rota não encontrada

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_inicial	String	10	Data inicial dos leads a serem recuperados. Exemplo: 2019-01-01
data_final	String	10	Data final dos leads a serem recuperados. Exemplo: 2019-01-01
pagina	Int	-	Parâmetro que indica a página que esta sendo consultada.