Bem vindo ao Sigavi 360

Esse documento descreve como você deve consumir as APIs de nossa plataforma.


As APIs do Sigavi 360 utilizam tecnologia REST (Representational State Transfer), baseado no protocolo HTTP.
Hoje em dia diversas empresas como Google, Facebook, LinkedIn, Netflix, entre outras, possuem soluções baseadas em REST com HTTP, o que faz essa tecnologia ser amplamente utilizada nos projetos modernos.

As requisições devem ser feitas através do método HTTP POST e para enviar o conteúdo utilize a notação JSON

Obs.: Se autentique no sistema para visualizar as credenciais de acesso e o formulário HTML para integração de Leads.


  • Autenticação
  • Integração de Leads
  • Chat
  • Clientes
  • Autônomos
  • Empreendimentos
  • Facebook

Para consumir qualquer API do Sigavi, é necessário utilizar uma API de autenticação. Para autenticação a nossa API vai solicitar os parâmetros abaixo:

username: Entre no sistema para obter o username e password

password: Entre no sistema para obter o username e password

grant_type: password


Layout dos Campos: Clique aqui

Endpoint: https://jdg.sigavi360.com.br/Sigavi/api/Acesso/Token


Será retornado um token através do parâmetro “access_token” com validade de 24 horas:

Imagem: https://www.getpostman.com/downloads


Token


O tipo de token utilizado é bearer, então na requisição de todos os demais métodos passe no header um parâmetro chamado Authorization e o conteúdo deverá ser obrigatoriamente "bearer + “ “ + access_token"


Imagem: https://www.getpostman.com/downloads


Integração via API


Esse método faz a importação de Leads geradas através de plataformas externas.

Os exemplos a seguir possuem os parâmetros básicos do Lead. Consulte o link abaixo para conhecer todos campos possíveis, como por exemplo praça de atendimento, campanha, código de referência do imóvel, etc.

Layout dos Campos: Clique aqui

Endpoint:

Formato de Request

application/json, text/json

Exemplo: 
{
    "Nome":"Nome Cliente Aqui",
    "Email":"mail@cliente.com",
    "Telefone":"(00) 00000-0000",
    "Mensagem":"mensagem cliente aqui",
    "Empreendimento": true,
    "Referencia": "987654"
}

Formato de Response

application/json, text/json

Exemplo: 
{
  "Id": 1,
  "Sucesso": true,
  "Erros": [
    "sample string 4"
  ]
}

Clientes

Retorna a ficha cadastral dos clientes/proprietarios.

Layout dos Campos: Clique aqui

Endpoint: https://jdg.sigavi360.com.br/Sigavi/api/Pessoa/Busca

1 - Site Externo, redirecionamento para Sigavi e Sigavi captura os dados do cliente:

A Sigavi faz a captura dos dados do cliente (Nome, E-mail, Telefone) e posteriormente encaminha para a fila de atendimento.

Apenas direcione cliente para o link abaixo:


Endpoint: https://jdg.sigavi360.com.br/Chat/NovoAtendimento/{Id-Produto}?midia={utm_source}

2 - Site Externo captura os dados do cliente, e envia ao Sigavi para entrar diretamente na fila de atendimento:

Se o site deseja capturar os dados do cliente e encaminhar o cliente para que entre direto na fila de atendimento, utilize o link abaixo passando os parâmetros solicitados:


Endpoint: https://jdg.sigavi360.com.br/Chat/NovoAtendimentoFila/{Id-Produto}?midia={utm_source}&nome={Nome}&email={email}&telefone={telefone}

Parâmetro Descrição Exemplo Observações
IDEmpreendimento Id do Empreendimento a qual a qual o cliente quer o chat 14 Opcional
midia Valor fixo, usamos para identificar a mídia origem do lead Site Obrigatório
nome Nome do cliente Darmameo Felatorond Obrigatório
email Email do Cliente darmameo.felatorond@prompt.com.br Obrigatório
telefone Telefone do cliente 1135001040 Opcional, mas se passar telefone seguem as regras abaixo: Passar apenas números Passar entre 8 e 11 caracteres Passar DDD + Numero tudo junto Se ultrapassar 11 caracteres cortamos em 11.

3 – Envio de Lead de Chat via API

Nesse formato o Lead é enviado via API, o Sigavi processa e retorna uma URL a qual o cliente deve ser direcionado para entrar na Fila.

Layout dos Campos: Clique aqui

Endpoint: https://jdg.sigavi360.com.br/Sigavi/api/Leads/NovoChat

Busca

Retorna todos os autônomos que satisfazem aos parametros informados no request.

Layout dos Campos: Clique aqui

Endpoint: https://jdg.sigavi360.com.br/TH/api/Autonomo/Busca

Busca

Retorna todos os empreendimentos que satisfazem aos parametros informados no request.

Layout dos Campos: Clique aqui

Endpoint: https://jdg.sigavi360.com.br/Sigavi/api/Site/BuscaEmpreendimento

Ficha Técnica

Retorna todas as informações de um empreendimento em específico.

Layout dos Campos: Clique aqui

Endpoint: https://jdg.sigavi360.com.br/Sigavi/api/Site/GetFichaTecnicaEmpreendimento

O Sigavi 360 permite que a sua empresa conecte o facebook ao Sigavi 360, dessa forma sempre que obtiver um lead pelo facebook ele será enviado automaticamente para o Sigavi. O Sigavi irá distribuir o lead para um corretor através das filas de rodizio, consulte o manual de rodizio para realizar as configurações das filas. Para integrar o facebook com o Sigavi é muito simples, siga os passos abaixo.


1 – Adicionando o Sigavi na sua página


Você precisa acessar a página onde estão seus formulários do facebook, depois vá em:

Configurações → Funções administrativas → Atribuir uma nova função da Página:

Adicione o Sigavi pesquisando por “Sigavi Prompt”

No botão ao lado, mude de Editor para Administrador

E clique em Adicionar, depois confirme com sua senha e clique em Confirmar.





2 – Notifique a Prompt


Após adicionar o Sigavi a sua página, notifique imediatamente a Prompt para que possamos validar sua solicitação. Somente após a Prompt validar a solicitação é que você poderá prosseguir com as etapas seguintes.


3 – Configurando o Sigavi


Agora é necessário realizar algumas configurações no Sigavi para que o Sigavi possa receber seus leads.

Acesse a tela de Integração Lead no caminho CRM → Administrar → Integração Lead




Clique em Facebook:



Clique no logo do facebook para se autenticar e informe suas credenciais do facebook (as mesmas credencias da conta que administra as suas páginas)




Depois clique em "OK"




Após clicar em OK, é necessário informar os campos abaixo.


Página: Informe o nome da página em que está seus formulários.

Formulário: Informe qual formulário deseja integrar.

Praça: Informe a praça de atendimento a qual esse formulário está vinculado.

Empreendimento: Caso o formulário seja de um empreendimento específico, então informe o nome do empreendimento.

Sincronizar lead antigo: Marque essa opção se deseja que o Sigavi recupere todos os leads que entraram no formulário. Se deixar desmarcado apenas os novos serão enviados para o Sigavi.


Clique em Salvar.




Será aberto uma tela para realizar o mapeamento dos campos dos formulários do facebook com os campos do Sigavi, os principais campos o Sigavi já faz a vinculação automaticamente.




Confirme todos os campos e clique em Salvar.


Pronto, o Sigavi já está 100% configurado, agora é só esperar os leads chegarem


4 – Buscando os formulários


Para realizar a busca de uma integração já cadastrada clique em Buscar: