Este artigo descreve os passos necessários para um sistema externo enviar um registro de indicação para o SnapProperty.
| Table of Contents |
|---|
Requisitos para integração
Para realizar a integração de um sistema externo, verifique se todas as condições abaixo foram atendidas.
- Criar uma "Aplicação conectada" para o sistema externo que pretende ser integrado.
- Criar um usuário para autenticar o sistema externo.
Regras de negócio
Indicação de cliente
O registro para indicação de um cliente é dividido em três partes:
- Indicador (pessoa que indica o cliente)
- Indicado (cliente indicado)
- Detalhes (detalhes da indicação)
Indicador
| Campo | Tipo | Obrigatório | Observação |
|---|---|---|---|
| Nome | String | Sim | Primeiro nome do indicador. Ex.: João |
| Sobrenome | String | Sim | Sobrenome do indicador. Ex.: Souza |
| String | Sim | Endereço de email do indicador. Ex.: joao.souza@gmail.com. O sistema valida o endereço de email. | |
| Celular | String | Sim | Telefone celular do indicador. Ex.: +55(11) 99422-3020 |
| CPF | String | Sim | CPF do indicador. Ex.: 150.117.518-17 |
Indicado
| Campo | Tipo | Obrigatório | Observação |
|---|---|---|---|
| Nome | String | Sim | Primeiro nome do indicado. Ex.: Maria |
| Sobrenome | String | Sim | Sobrenome do indicado. Ex.: Menezes |
| String | Sim | Endereço de email do indicado. Ex.: maria.menezes@gmail.com. O sistema valida o endereço de email. | |
| Celular | String | NãoSim | Telefone celular do indicado. Ex.: +55(11) 99425-8320 |
| CPF | String | Não | CPF do indicado. Ex.: 170.187.518-17 |
Detalhes
| Campo | Tipo | Obrigatório | Observação | ||||
|---|---|---|---|---|---|---|---|
| Tipo de negócio | Lista de valores:
| String | Sim | Indica o tipo de negócio para o qual o cliente foi indicado. | Data da indicação | Não | Quando não for informada, o sistema utiliza a data do processamentoAs opções são: Locação ou Captação. |
| Origem | String | Sim | Indica o parceiro que originou a indicação. As opções são: Buzzlead. | ||||
| Campanha | String | Não | Código para identificação da campanha que originou a indicação . A campanha deve ser criada pelo administrador do SnapProperty e deve estar ativa, informado pelo administrador da organização. |
Fluxo para integração
| Lucidchart | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
API para integração
O SnapProperty disponibiliza uma API para receber indicações de clientes de sistemas externos.
Requisitos para integração
Para realizar a integração de um sistema externo, o administrador da organização deve concluir as seguintes atividades:
- Criar uma "Aplicação conectada" para o sistema externo que pretende enviar indicações.
- Criar um usuário para autenticar o sistema externo.
Token de acesso
Antes de enviar uma requisição de cadastro para uma nova indicação, o sistema externo deve solicitar um token de acesso.
Para mais informações, consulte o link abaixo:
...
Requisição
Para enviar uma indicação, o sistema externo deve receber um token de segurança que é utilizado para autenticar as requisições para a API do SnapProperty.
| Parâmetro | Descrição |
|---|---|
| Endpoint | Endereço para enviar a requisição do token de segurança. Utilizar sempre https://login.salesforce.com/services/oauth2/token/ |
| Verbo | Utilizar sempre POST |
| grant_type | Identifica o tipo de requisição. Deve utilizar sempre "password". |
| client_id | Código para identificação da aplicação no Salesforce, informado pelo administrador da organização. |
| client_secret | Chave secreta da aplicação, informado pelo administrador da organização. |
| username | Nome do usuário para autenticação, cadastrado pelo administradora da organização. |
| password | Senha utilizada pelo usuário para autenticação concatenada com a chave de segurança enviada por email pelo Salesforce. |
Retorno
| Parâmetro | Descrição |
|---|---|
Exemplo de requisição com suceso
| Exemplo | |
|---|---|
| Requisição | https://login.salesforce.com/services/oauth2/token |
| Retorno | { "access_token": "00DU0000000KkSx!ARQAQCV4Ss4lCPejtaWcCz3W.26oOVeAbvxaAU4BndfDvDk5CoRKSWUubdF7XjNulocbDRlPU81DjNT0.kiFhIr.Kbz", "instance_url": "https://snap-broker-dev-ed.my.salesforce.com", "id": "https://login.salesforce.com/id/00DU0000000KkSxMAK/005U0000000NVceIAG", "token_type": "Bearer", "issued_at": "1556731033567", "signature": "15dl4dW8LSkp+r1FHbj/Y/3mD/AiRrKB0HNee4IGa+A=" } |
...
{
"access_token": "00DU0000000KkSx!ARQAQCV4Ss4lCPejtaWc3rWJBCz3W.26oOVeAbvxaAU4BndfDvDk5CoRKSWUubdF7XjNulocbDRlPU81DjNT0.kiFhIr.Kbz",
"instance_url": "https://snap-broker-dev-ed.my.salesforce.com",
"id": "https://login.salesforce.com/id/00DU0000000KkSxMAK/005U0000000NVceIAG",
"token_type": "Bearer",
"issued_at": "1556731033567",
"signature": "15dl4dW8LSkp+r1FHbj/Y/3mD/AiRrKB0HNee4IGa+A="
}
Cadastrar uma nova indicação
Para cadastrar uma nova indicação, o sistema externo deve enviar uma requisição para a API do SnapProperty, com os seguintes parâmetros:
| Parâmetro | Valor | Notas |
|---|---|---|
| Endpoint | https://snap-broker-dev-ed.my.salesforce.com/services/apexrest/snap_brok/indicacao/v1 | Solicite ao administrador |
| Verbo | POST |
...