Este artigo descreve os passos necessários para um sistema externo enviar um registro de indicação para o SnapProperty.
...
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 | Tipo | Descrição |
|---|---|---|
| Endpoint | String | Endereço para enviar a uma requisição do para token de segurançaacesso. Utilizar sempre https://login.salesforce.com/services/oauth2/token/ |
| Verbo | String | Utilizar sempre POST |
| grant_type | String | Identifica o tipo de requisição. Deve utilizar sempre "password". |
| client_id | String | Código para identificação da aplicação no Salesforce, informado pelo administrador da organização. |
| client_secret | String | Chave secreta da aplicação, informado pelo administrador da organização. |
| username | String | Nome do usuário para autenticação, cadastrado pelo administradora da organização. |
| password | String | Senha 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âmetro | Tipo | Descrição |
|---|---|---|
| access_token | String | Chave de acesso para as demais requisições para a API. |
| instance_url | String | Este valor será utilizado nas demais requisições para a API. |
| id | String | |
| token_type | String | |
| issued_at | String | |
| signature | String |
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=" } |
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 |
|---|
| Tipo |
|---|
| Descrição | ||
|---|---|---|
| Endpoint | String | 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 |