CRM Zen
Calendário (Entrada)
Calendário (Saída)

Integração de Calendário (Saída) Versão 1.0


Introdução

Esta API integra os eventos do CRM Zen com os eventos do sistema do cliente. Quando houver alguma ação no Zen, nosso sistema manda automaticamente os dados para o sistema do cliente.

Obs.: Caso a opção "Enviar detalhes de notas" esteja selecionada na seção de Integração do Zen, quando houver alguma ação nas notas vinculadas ao evento, o sistema também manda automaticamente os dados para o sistema do cliente.

Como integrar à API

É necessário informar a URL de ação no campo disponível na área de Integração de Calendário (Saída), na seção de Integração do Zen (No topo do CRM Zen, clique no ícone de engrenagem e depois selecione Integração).

Exemplo de URL do cliente:


http://{URL_DO_CLIENTE}?token={TOKEN}

A URL_DO_CLIENTE é o endereço do sistema do cliente que receberá o POST.
O token é uma chave de segurança do sistema do cliente que receberá o POST.
Toda URL deve conter o parâmetro token na querystring.

 

Requisições

O Zen enviará um POST com os dados em formato JSON (Ver modelos abaixo) para a URL_DO_CLIENTE fornecida.


Respostas

Todas as respostas devem estar no formato JSON.
De modo geral, respostas bem sucedidas devem retornar o Código 200.

	
   {
     "Codigo" : "Número",
     "Mensagem" : "Descrição"
   }
Obs.: Caso ocorra alguma falha na requisição, uma fila será mantida e disponibilizada em um painel para novas tentativas.


Inserir evento

STRING JSON Padrão que será enviada por POST ao ser incluído um evento no CRM Zen:
Ver Modelo


Editar evento

STRING JSON Padrão que será enviada por POST ao ser editado um evento no CRM Zen:
Ver Modelo


Parâmetros (Inserir e Editar)

Parâmetro Tipo Tamanho Descrição
Acao String 10 Ação realizada (Inserir/Editar)
Por String 150 Email de quem realizou a ação
Compartilhamento String 15.000 Emails de usuários que podem ver o evento. Separados por vírgula.
(até 150 caracteres cada email)
Integracao String 50 Código de Integração do evento
Titulo String 100 Título do evento
Data_Inicial String 10 Data inicial do evento (Se vazio, será gravado como a data de envio) (Obrigatório)
Data_Final String 10 Data final do evento (Se vazio, será gravado como a data de envio) (Obrigatório)
Aniversario String 1 0 (Não é aniverário) (Padrão: 0)
1 (É aniversário)
Hora_Inicial String 8 Hora inicial do evento (Padrão 8:00) (Obrigatório)
Hora_Final String 8 Hora final do evento (Padrão 8:30) (Obrigatório)
Lembrete->Quantidade Inteiro   Exemplo: 15 (15 dias)
Lembrete->Tipo String 7 Tipos aceitos: minutos, horas, dias, semanas
Lembrete->Aviso_Sonoro String 1 0 = Criar aviso sonoro no desktop para todos os usuários que podem ver o evento
1 = Não criar aviso sonoro
Local String 256 Local do evento
Sala->Nome String 50 Nome da sala (Obrigatório)
Sala->Codigo String 50 Código da sala
Categoria->Nome String 100 Nome da Categoria
Categoria->Codigo String 50 Código da Categoria
Status->Nome String 70 Status do evento
Status->Codigo String 50 Código do Status
Recorrencia->Repetir String 12 Tipos aceitos: diariamente, semanalmente, mensalmente, anualmente. (Padrão: Nunca)
Recorrencia->Ate String 10 Data final da recorrência
Contatos_Associados->Integracao String 50 Códigos de integração dos contatos associados ao evento
Observacao String 1000 Observação
Tag String 1000 Tags separadas por vírgula e com 50 caracteres cada
Notas_Vinculadas->IdNota * String 10 Código de Integração da nota
Notas_Vinculadas->Texto* String 5.000 Texto da nota
Notas_Vinculadas->Data* String 10 Data de criação da nota (na ação Inserir)
Data de edição da nota (na ação Editar)
Notas_Vinculadas->Horario* String 8 Horário de criação da nota (na ação Inserir) (Se vazio, será gravado como o horário de envio)
Horário de edição da nota (na ação Editar) (Se vazio, será gravado como o horário de envio)
Notas_Vinculadas->Categorias->IdCategoria* String 10 Código de integração da categoria
Notas_Vinculadas->Categorias->NomeCategoria* String 70 Nome da categoria
Notas_Vinculadas->Subcategorias->
IdSubcategoria*		 String 10 Código de integração da subcategoria
Notas_Vinculadas->Subcategorias->
NomeSubcategoria*		 String 70 Nome da Subcategoria

*Obs.: Para enviar os detalhes das notas vinculadas é necessário selecionar a opção "Enviar detalhes de notas" na área de Integração de Calendário (Saída), na seção de Integração do Zen (No topo do CRM Zen, clique no ícone de engrenagem e depois selecione Integração)


Excluir evento

STRING JSON Padrão que será enviada por POST ao ser excluído um evento no CRM Zen:
Ver Modelo


Parâmetros (Excluir)

Parâmetro Tipo Tamanho Descrição
Acao String 10 Ação realizada (Excluir)
Por String 150 Email de quem realizou a ação
Integracao String 50 Código de Integração do evento