# Tutorial para integração SAN e Sohtec - Inserção de atendimento Sohtec no SAN

###### Documento destinado a todas as associadas ou a Sohtec que irá realizar a integração

> O intuito deste documento e auxiliar a integrar o SAN da sua agencia
> com a sua conta da Sohtec.
> Após esta configuração você irá receber no SAN os Leads originados
> da plataforma da Sohtec.
>
> Qualquer dúvida que exisitir poderá ser encaminhada para
> o suporte através do [e-mail] com o assunto "Ingegração SAN - Sohtec"

## Os passos da implementação

## :computer: Informações da API

### Passo 1: Metodo de uso:

Foi desenvolvido um novo metodo em nossa API para que a Sohtec envie os dados referentes do atendimento do cliente:

#### :rocket: Atendimento Sohtec

- Url para acesso do metodo: http://wcfservices.redenetimoveis.com.br/docs/#!/IntegracaoTerceiros/IntegracaoTerceiros_InsertAtendimentoSohtec

#### :open_book: Dados para acessar o método


- APIKey: A chave da API você deverá solicitar ao Suporte da Netimóveis através do email [e-mail] com o assunto, "Chave Integração - Sohtec SAN"

- token: O Token de acesso você deverá solicitar ao Suporte da Netimóveis através do email [e-mail] com o assunto, "Token de Administração - Sohtec"

- Dados de envio: Vocês devem enviar um objeto com os seguintes itens atribuidos:

---

{
  "AgenciaSanId": int,
  "ImovelSanId": int,
  "NomeCliente": string,
  "EmailCliente": string,
  "DDIClienteTelefone": string,
  "TelefoneCliente": string,
  "TextoDoCliente": string,
  "EmailAgencia": string,
  "ReceberInformacaoDeImovel": boolean,
  "AcessoAgenciaSite_Id": int,
  "Rastreamento": string,
  "Usuario_Id": int,
  "Integrador": int,
}

> ***AgenciaSanId***: O AgenciaSanId é o nosso identificador da associada em nossa plataforma, para vocês terem acesso ao ID solicitamos que envie um email para [e-mail] solicitando qual o ***AgenciaSanId*** da associada ou as associadas que possui integração com vocês. ==***Este campo é obrigatório***==

> ***ImovelSanId***: O ImovelSanId é o nosso identificador do imóvel, ele sempre é informado nós anúncios, não existe id's diferentes quando estão em outros portais como zap, viva real ou olx. ==***Este campo é obrigatório***==

> ***NomeCliente***: O NomeCliente deve ser informado o mesmo que o cliente preecheu no formulário.

> ***EmailCliente***: O EmailCliente deve ser informado o mesmo que o cliente preecheu no formulário. ==***Este campo é obrigatório***==

> ***DDIClienteTelefone***: O DDIClienteTelefone deve ser informado o mesmo que o cliente preecheu no formulário, a separação do DDICliente é justamente para processos dentro do SAN, então deve ser enviado separado. Lembrando que o DDI deverá ser enviado completo, exemplo: '**+55' ou '+1'**. ==***Este campo é obrigatório sé o telefone for preechido***==

> ***TelefoneCliente***: O TelefoneCliente deve ser informado o mesmo que o cliente preecheu no formulário.

> ***TextoDoCliente***: O TextoDoCliente deve ser informado o mesmo que o cliente preecheu no formulário.

> ***EmailAgencia***: O EmailAgencia deve ser informado o email da sohtec que recebeu este atendimento, é o email que representa aquela associada dentro da sohtec. ==***Este campo é obrigatório***==

> ***ReceberInformacaoDeImovel***: O ReceberInformacaoDeImovel é um parametro para a LGPD, informa se o usuário deseja receber informações sobre mais imóveis ou sobre este imóvel, muitos formulário possui esta informação, um exemplo é a imagem abaixo:


> ***AcessoAgenciaSite_Id***: O AcessoAgenciaSite_Id neste primeiro momento deverá ser informado NULL, depois vamos atribuir uma outra função a este campo para vocês da sohtec. ==***Este campo é obrigatório***==

> ***Rastreamento***: O Rastreamento é como o SAN realiza a identificação da fonte deste lead, temoos uma tabela da qual vamos disponibilizar a nomenclatura correta que vocês devem nós informar, pois assim poderemos identificar de onde este lead chegou. ==***Este campo é obrigatório***==

> ***Usuario_Id***: O Usuario_Id neste primeiro momento deverá ser informado 0, depois vamos atribuir uma outra função a este campo para vocês da sohtec. ==***Este campo é obrigatório***==

> ***Integrador***: O Integrador é como você será identificado no SAN, o Integrador da Sohtec é ==***13***==. ==***Este campo é obrigatório***==

---

#### :star: Dados sobre rastreamento

| Rastreamento | Código | Obs |
| -------- | -------- | -------- |
| ZAP | ZAP | Sempre que o lead vier do portal ZAP o códio de rastremanto deverá ser **ZAP**
|VivaReal | VivaReal | Sempre que o lead vier do portal Viva Real o código de rastreamento deverá ser **VivaReal**
| ImovelWeb | ImovelWeb | Sempre que o lead vier do portal ImovelWeb o códio de rastremanto deverá ser **ImovelWeb**
|LugarCerto | LugarCerto | Sempre que o lead vier do portal LugarCerto o código de rastreamento deverá ser **LugarCerto**
|OLX | OLX | Sempre que o lead vier do portal OLX o código de rastreamento deverá ser **OLX**

### Passo 2: Retorno da API

- Quando o consumo do método for realizado você irá receber o seguinte retorno:

{
  "Erro": boolean,
  "Mensagem": string
}

> ***Erro***: Você vai receber um Boolean informando se houve erro ou não na requisição do método.

> ***Mensagem***: Receberá a mensagem de confirmação da inclusão de atendimento ou o erro que aconteceu na ação.

:::info
:bulb: **Integração:** Todos os dados requisitados neste procedimento são necessários para o funcionamento correto das funcionalidades que já estão presentes hoje no SAN.
:::