Integração de Notas (Saída)

Notas (Saída)

Integração de Notas (Saída) Versão 1.0

Introdução

Esta API integra as notas dos contatos do CRM Zen com as notas dos contatos do sistema do cliente. Quando houver alguma ação no Zen, nosso sistema 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 Notas (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 nota

STRING JSON Padrão que será enviada por POST ao ser incluída uma nota em um contato no CRM Zen:
Ver Modelo

 {
        "Acao" : "Inserir",
        "Por" : "",
        "Compartilhamento" : "",
        "Integracao" : "",
        "IdNota" : "",
        "Texto" : "",
        "Data" : "",
        "Horario" : "",
        "Categorias":
       	[
           {
              "IdCategoria": "",
              "NomeCategoria": "",
              "Subcategorias": 
       			[
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" },
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" },
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" },
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" }
       			]
          }
       	]
 }

Editar nota

STRING JSON Padrão que será enviada por POST ao ser editada uma nota em um contato no CRM Zen:
Ver Modelo

 {
        "Acao" : "Editar",
        "Por" : "",
        "Compartilhamento" : "",
        "Integracao" : "",
        "IdNota" : "",
        "Texto" : "",
        "Data" : "",
        "Horario" : "",
        "Categorias":
       	[
           {
              "IdCategoria": "",
              "NomeCategoria": "",
              "Subcategorias": 
       			[
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" },
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" },
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" },
       				{ "IdSubcategoria": "" , "NomeSubcategoria" : "" }
       			]
          }
       	]
 }

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 a nota do contato. Separados por vírgula. (até 150 caracteres cada email)
Integracao	String	50	Código de Integração do contato
IdNota	String	10	Código de Integração da nota
Texto	String	5.000	Texto da nota
Data	String	10	Data de criação da nota (na ação Inserir) Data de edição da nota (na ação Editar)
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)
Categorias->IdCategoria	String	10	Código de integração da categoria
Categorias->NomeCategoria	String	100	Nome da categoria
Subcategorias->IdSubcategoria	String	10	Código de integração da subcategoria
Subcategorias->NomeSubcategoria	String	100	Nome da Subcategoria

Excluir nota

STRING JSON Padrão que será enviada por POST ao ser excluída uma nota de um contato no CRM Zen:
Ver Modelo

	
{
  "Acao" : "Excluir",
  "Por" : "",
  "Integracao" : "",
  "IdNota" : ""
}

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 contato
IdNota	String	10	Código de Integração da nota