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
Nome	String	Sim
Sobrenome	String	Sim
Email	String	Sim
Celular	String	Sim
CPF	String	Sim

Indicado

Campo	Tipo	Obrigatório
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: Captação Locação	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

Para mais informações, consulte o link abaixo:

https://developer.salesforce.com/docs/atlas.en-us.218.0.api_rest.meta/api_rest/intro_understanding_username_password_oauth_flow.htm

Receber o token de segurança

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

	Exemplo
Requisição	https://login.salesforce.com/services/oauth2/token?grand_type=password&client_id=3MVG9QDx8IX8nP5SIyDa4YCKZ5fWQe4zJBToiPFMmU94sSExkYBBr3gNZnzXXUS316&client_secret=065345560BF35CD3F101EAB2B9F1838B402D4903&username=sistema@dominio.com.br&password=senha23409284203942
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=" }

Exemplo de retorno:

{
"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

Integração para indicação