CRM Zen

Arquivo de Leads Versão 1.0


Introdução

Esta API retorna todos os leads que foram criados e/ou alterados no dia anterior (Sem o parâmetro de data) ou na data requisitada.

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 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 = "https://api.crmzen.com.br/api/arquivo-lead/";
    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 criação e/ou alteração dos leads",
    "leads": [
        {
            "integracao_lead": "Código de integração do lead (Contato)",
            "data_criacao_lead": "Data e hora da criação do lead (Negócio)",
            "status_lead": "Status do lead (Andamento, Finalizado ou Cancelado)",
            "data_status_lead": "Data e hora do status do lead",
            "etapa_lead": "Etapa do lead",
            "data_etapa_lead": "Data e hora da etapa do lead",
            "classificacao_lead": "Classificação do lead (Prospectando, Qualificado ou Não Qualificado)",
            "data_classificacao_lead": "Data e hora da classificação do lead",
            "nome_usuario_responsavel": "Nome do responsável do lead",
            "email_usuario_responsavel": "E-mail do responsável do lead"
        }
    ]
}
Obs.: A API retorna o HTTP Status 400 quando nenhum negócio foi criado ou alterado no dia anterior ou na data requisitada.

Erros

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

Mensagens de retorno

200 OK
  • Sucesso
400 Bad Request
  • O arquivo de leads não foi encontrado.
  • O arquivo de leads não foi encontrado para a data solicitada.
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 String 10 Data de criação e/ou alteração dos leads. Exemplo: 2024-01-01