You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 7
Next »
Este artigo descreve os passos necessários para um sistema externo enviar um registro de indicação para o SnapProperty.
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 |
|
| Sobrenome | String | Sim |
|
| Email | String | Sim |
|
| Celular | String | Sim |
|
| CPF | String | Sim |
|
Indicado
| Campo | Tipo | Obrigatório | Observação |
|---|
| Nome | String | Sim |
|
| Sobrenome | String | Sim |
|
| Email | String | Sim |
|
| Celular | String | Não |
|
| CPF | String | Não |
|
Detalhes
| Campo | Tipo | Obrigatório | Observação |
|---|
| Tipo de negócio | Lista de valores:
| 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 processamento. |
| Origem | String | Sim | Indica o parceiro que originou a indicação. |
| 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. |
Fluxo para integração
API para integração
Receber o token de segurança
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. |
| Exemplo |
|---|
| https://login.salesforce.com/services/oauth2/token?grand_type=password&client_id=3MVG9QDx8IX8nP5SIyDa4YCKZ5fWQe4zJBToiPFMmU94sSExkYBBr3gNZnzXXUS316&client_secret=065345560BF35CD3F101EAB2B9F1838B402D4903&username=sistema@dominio.com.br&password=senha23409284203942 |
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: