CRM Zen - API de Rastreabilidade

API de Rastreabilidade Versão 1.0

Introdução

Esta API recebe um JSON e devolve as informações de log do contato

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 3 segundos

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

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

Exemplos de requisições:

PHP(cURL)


              
    $json = json_encode($dados);

    $token = 'Seu token';

    $ch = curl_init();
    $url = "{URL}";
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
      "token: $token",
      "Content-Type: application/json",
      "Content-Length: " . strlen($json)
    ));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $retorno = curl_exec($ch); //VER MENSAGENS DE RETORNO PADRÃO
    curl_close($ch);

NODEJS(Request)

                
              
    $json = json_encode($dados);

    $token = 'Seu token';

    var request = require('request');
    var options = {
      'method': 'GET',
      'url': '{URL}',
      'headers': {
      'token': $token,
      'Content-Type': 'application/json'
      },
    body: JSON.stringify($json)
    };
    request(options, function (error, response) { 
      if (error) throw new Error(error);
      console.log(response.body);//VER MENSAGENS DE RETORNO PADRÃO
    });

JAVA(OkHttp)

                
                
$json = json_encode($dados);

$token = 'Seu token';

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, $json);
Request request = new Request.Builder()
  .url("{URL}")
  .method("GET", body)
  .addHeader("token", $token)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request)
  .execute();//VER MENSAGENS DE RETORNO PADRÃO

PYTHON(Requests)

                
              
    $json = json_encode($dados);

    $token = 'Seu token';

    url = "{URL}"
    payload = $json
    headers = {
      'token': $token,
      'Content-Type': 'application/json'
    }
    response = requests.request("GET", 
      url, headers=headers, data = payload)
    print(response.text.encode('utf8'))//VER MENSAGENS DE RETORNO PADRÃO

C#(RestSharp)

                
              
    $json = json_encode($dados);

    $token = 'Seu token';

    var client = new RestClient("{URL}"); 
    client.Timeout = -1;
    var request = new RestRequest(Method.GET);
    request.AddHeader("token", $token );
    request.AddHeader("Content-Type", "application/json");
    request.AddHeader("Content-Type", "text/plain");
    request.AddParameter("application/json,text/plain", $json,  
      ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);
    Console.WriteLine(response.Content);

Respostas

Todas as respostas estarão no formato JSON no modelo REST;

Respostas bem sucedidas retornarão o código HTTP 200;

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

Erros

            
    {
      "Status": "Mensagem de erro",
      "StatusCode": "Resposta HTTP",
      "StatusMsg": "Mensagem com o status da ação"
    }

Mensagens de retorno

200 OK

JSON com os dados

400 Bad Request

Json inválido
A palavra dia não pode ser editada ou removida!
O valor do parâmetro dia é obrigatório!
O parâmetro dia contém um valor inválido!
O parâmetro dia excedeu o limite de 2 caracteres!
O parâmetro dia deve receber apenas números!
O parâmetro dia deve receber um número entre 01 e 31!
O parâmetro dia deve ser do tipo string!
O parâmetro mes é obrigatório!
A palavra mes não pode ser editada ou removida!
O valor do parâmetro mes é obrigatório!
O parâmetro mes contém um valor inválido!
O parâmetro mes excedeu o limite de 2 caracteres!
O parâmetro mes deve receber apenas números!
O parâmetro mes deve receber um número entre 01 e 12!
O parâmetro mes deve ser do tipo string!
O parâmetro ano é obrigatório!
A palavra ano não pode ser editada ou removida!
O valor do parâmetro ano é obrigatório!
O parâmetro ano contém um valor inválido!
O parâmetro ano excedeu o limite de 4 caracteres!
O parâmetro ano deve receber apenas números!
O parâmetro ano deve ser do tipo string!
O parâmetro paginacao é obrigatório!
A palavra paginacao não pode ser editada ou removida!
O valor do parâmetro paginacao é obrigatório!
O parâmetro paginacao deve receber apenas números!
O parâmetro paginacao deve ser do tipo string!
O parâmetro 'paginacao' excedeu o limite de 5 caracteres!

401 Unauthorized

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

404 Not Found

Rota não encontrada
Não existe paginação com a data informada!
O arquivo com os parâmetros informados não existe no servidor!

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!

Buscar quantidade de paginação - Método `GET`

Exemplo de URL:


    https://{URL}/buscapaginacao

STRING JSON Padrão para busca de quantidade de paginação:

       
    {
      "dia": " ",
      "mes" : " ",
      "ano": " "
    }

Parâmetro	Tipo	Tamanho	Obrigatório	Descrição
dia	String	2	Sim	Dia para busca da paginação
mes	String	2	Sim	Mês para busca da paginação
ano	String	4	Sim	Ano para busca da paginação

Modelo de resposta - Paginação

       
    {
      "paginacao": " ",
      "data": " "
    }

Parâmetro	Tipo	Tamanho	Descrição
paginacao	String	1000	Quantidade de páginas
data	String	10	Data da pesquisa da paginação

Buscar dados do log de contato - Método `GET`

Exemplo de URL:


    https://{URL}/buscadados

STRING JSON Padrão para busca dos dados de log:

       
    {
      "dia": " ",
      "mes" : " ",
      "ano": " ",
      "paginacao" : " "
    }

Parâmetro	Tipo	Tamanho	Obrigatório	Descrição
dia	String	2	Sim	Dia para busca dos dados
mes	String	2	Sim	Mês para busca dos dados
ano	String	4	Sim	Ano para busca dos dados
paginacao	String	1000	Sim	Parâmetro utilizado para buscar os dados por paginação

Modelo de resposta - Dados do log de contato

       
     {
        "NomeConta": "",
        "idContaRastreio": "",
        "NomeUsuario": "",
        "EmailUsuario": "",
        "MatriculaUsuario": "",
        "Acao": "",
        "Data": "",
        "Hora": "",
        "DataCadastroContato": "",
        "DadosContato": {
            "Integracao": "",
            "Nome": "",
            "Sobrenome": "",
            "CPF": "",
            "RG": "",
            "Sexo": "",
            "Nascimento": "",
            "Razao": "",
            "Fantasia": "",
            "CNPJ": "",
            "Tipo": "",
            "Email": {
                "Email1": "",
                "Email2": "",
                "Email3": "",
                "Email4": "",
                "Email5": ""
            },
            "Website": "",
            "Endereco": {
                "Endereco": "",
                "Numero": "",
                "Complemento": "",
                "Bairro": "",
                "Cidade": "",
                "Estado": "",
                "Cep": "",
                "Pais": ""
            },
            "Telefone": [
                {
                    "Tipo": "",
                    "DDI": "",
                    "DDD": "",
                    "Telefone": "",
                    "Ramal": ""
                },
                {
                    "Tipo": "",
                    "DDI": "",
                    "DDD": "",
                    "Telefone": "",
                    "Ramal": ""
                },
                {
                    "Tipo": "",
                    "DDI": "",
                    "DDD": "",
                    "Telefone": "",
                    "Ramal": ""
                },
                {
                    "Tipo": "",
                    "DDI": "",
                    "DDD": "",
                    "Telefone": "",
                    "Ramal": ""
                },
                {
                    "Tipo": "",
                    "DDI": "",
                    "DDD": "",
                    "Telefone": "",
                    "Ramal": ""
                }
            ],
            "Redes": {
                "Linkedin": "",
                "Twitter": "",
                "Facebook": "",
                "GooglePlus": ""
            },
            "Campos": [
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                },
                {
                    "Titulo": "",
                    "Valor": ""
                }
            ],
            "Observacao": "",
            "Tag": "",
            "Optinout": "",
            "DataRemocao": "",
            "Motivo": ""
        }
    }

Parâmetro	Tipo	Tamanho	Descrição
NomeConta	String	50	Nome personalizado da conta
idContaRastreio	String	50	Id para identificação da conta
NomeUsuario	String	100	Usuário que realizou a ação
EmailUsuario	String	80	E-mail do usuário que realizou a ação
Matricula	String	50	Matrícula do usuário que realizou a ação
Acao	String	30	Ação realizada pelo usuário em um contato (criar, visualizar, editar e remover)
Data	String	10	Data da ação
Hora	String	10	Hora da ação
DataCadastroContato	String	10	Data do cadastro do contato
Integracao	String	50	Código de Integração do contato
Nome	String	100	Apenas para Pessoa Física
Sobrenome	String	120	Apenas para Pessoa Física
CPF	String	11	Apenas para Pessoa Física. Sem pontos, barras ou traços
RG	String	20	Apenas para Pessoa Física
Sexo	String	1	F (Feminino) /M (Masculino). Apenas para Pessoa Física
Nascimento	String	10	dd/mm/aaaa. Apenas para Pessoa Física
Razao	String	120	Razão social. Apenas para Pessoa Jurídica
Fantasia	String	120	Nome fantasia. Apenas para Pessoa Jurídica
CNPJ	String	14	Apenas para Pessoa Jurídica. Sem pontos, barras ou traços
Tipo	String	1	F (Física) /J (Jurídica)
Emails	String	150	E-mails (Até 5 e-mails com 150 caracteres cada)
Website	String	180	Website
Endereco	String	120	Endereço
Numero	String	20	Número
Complemento	String	50	Complemento
Bairro	String	100	Bairro
Cidade	String	100	Cidade
Estado	String	80	Estado
CEP	String	8	CEP
Pais	String	80	País
Telefone-> Tipo	String	20	Tipo do telefone (Tipos existentes: Residencial, Comercial, Celular, Residencial Fax, Fax, Nextel, Outros, Celular Vivo, Celular Oi, Celular Tim, Celular Claro, Celular Sercontel, Celular CTBC e Celular Conecta)
Telefone-> DDI	String	4	DDI
Telefone-> DDD	String	4	DDD
Telefone-> Telefone	String	24	Número do telefone
Telefone-> Ramal	String	20	Ramal
Redes	String	120	Redes Sociais com 120 caracteres cada
Campos-> Título	String	50	Título dos Campos Personalizados com 50 caracteres cada
Campos-> Valor	String	100	Valor dos Campos Personalizados com 100 caracteres cada
Observacao	String	5000	Observação do contato
Tag	String	1000	Tags separadas por vírgula e com 50 caracteres cada
Optinout	String	1	Opt-in = 1 / Opt-out = 0
DataRemocao	String	10	dd/mm/aaaa. Data limite da restrição de remoção do contato
Motivo	String	250	Motivo da restrição do contato