CRM Zen

Consulta de Contatos Versão 1.0


Introdução

Esta API recebe dois parâmetros: o código de integração do contato(Caractere), e página(Numérico). A mesma retorna todos os dados referente ao contato. Sendo que, a mesma pode retornar os dados do contato, as suas notas ou os seus negócios. Dependendendo da Rota acessada.

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. Com isso, o parâmetro 'pagina' indica a página atual que esta sendo consultada.

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

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

Erros

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

Mensagens de retorno

200 OK
  • Sucesso
400 Bad Request
  • O parâmetro 'pagina' dever ser numérico!
  • O parâmetro 'integracao' é necessário!
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 Obrigatório
codigo_integracao String 15 Código de integração do contato Sim
pagina Int 1 Parâmetro que indica a página que esta sendo consultada. Não