Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Este artigo descreve os passos necessários para um sistema externo enviar um registro de indicação para o SnapProperty.

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

CampoTipoObrigatórioObservação
NomeStringSimPrimeiro nome do indicador. Ex.: João
SobrenomeStringSimSobrenome do indicador. Ex.: Souza
EmailStringSimEndereço de email do indicador. Ex.: joao.souza@gmail.com. O sistema valida o endereço de email.
CelularStringSimTelefone celular do indicador. Ex.: +55(11) 99422-3020
CPFStringSimCPF do indicador. Ex.: 150.117.518-17

Indicado

CampoTipoObrigatórioObservação
NomeStringSimPrimeiro nome do indicado. Ex.: Maria
SobrenomeStringSimSobrenome do indicado. Ex.: Menezes
EmailStringSimEndereço de email do indicado. Ex.: maria.menezes@gmail.com. O sistema valida o endereço de email.
CelularStringSimTelefone celular do indicado. Ex.: +55(11) 99425-8320
CPFStringNãoCPF do indicado. Ex.: 170.187.518-17

Detalhes

CampoTipoObrigatórioObservação
Tipo de negócioStringSimIndica o tipo de negócio para o qual o cliente foi indicado. As opções são: Locação ou Captação.
OrigemStringSimIndica o parceiro que originou a indicação. As opções são: Buzzlead.
CampanhaStringNão

Código para identificação da campanha que originou a indicação, informado pelo administrador da organização.

Fluxo para integração

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:

  1. Criar uma "Aplicação conectada" para o sistema externo que pretende enviar indicações.
  2. 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:

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

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âmetroTipoDescrição
EndpointStringEndereço para enviar uma requisição para token de acesso. Utilizar sempre https://login.salesforce.com/services/oauth2/token/
VerboStringUtilizar sempre POST
grant_typeStringIdentifica o tipo de requisição. Deve utilizar sempre "password".
client_idStringCódigo para identificação da aplicação no Salesforce, informado pelo administrador da organização.
client_secretStringChave secreta da aplicação, informado pelo administrador da organização.
usernameStringNome do usuário para autenticação, cadastrado pelo administradora da organização.
passwordStringSenha utilizada pelo usuário para autenticação concatenada com a chave de segurança enviada por email pelo Salesforce.

Retorno de uma requisição bem sucedida

ParâmetroTipoDescrição
access_tokenStringChave de acesso para as demais requisições para a API.
instance_urlStringEste valor será utilizado nas demais requisições para a API.
idString
token_typeString
issued_atString
signatureString

Exemplo de requisição com suceso


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="
}


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âmetroTipoDescrição
EndpointString

O endereço da requisição é formado por duas partes concatenadas: "URL da instância" + "Nome do recurso".

A "URL da instância" é o valor retornado no parâmetro "instance_url" da requisição para o token de acesso.

O "Nome do recurso" é "/services/apexrest/snap_brok/indicacao/v1"

Exemplo: https://snap-broker-dev-ed.my.salesforce.com/services/apexrest/snap_brok/indicacao/v1

Verbo
POST
  • No labels