Расширение Salesforce

Вы просматриваете документацию Apigee Edge .
Перейти к документации Apigee X. info

Версия: 2.0.1

Доступ к данным в вашей учетной записи Salesforce. Вставка, обновление, извлечение и запрос данных.

В этом контенте содержится справочная информация по настройке и использованию этого расширения.

Предпосылки

Этот контент предоставляет справочную информацию по настройке и использованию этого расширения. Перед использованием расширения из API-прокси с помощью политики ExtensionCallout необходимо:

1. Создайте пару закрытый ключ/сертификат RSA x509.

   Вы будете использовать закрытый ключ (.key) в качестве учетных данных при настройке расширения. Вы будете использовать файл сертификата (.crt) при создании подключенного приложения, которое предоставит расширению доступ к Salesforce.

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. Настройте подключенное приложение.

   Подключенное приложение Salesforce предоставит доступ к расширению Salesforce. Инструкции по настройке приложения см. ниже.

3. Получите ключ потребителя для подключенного приложения. Расширение будет использовать его при аутентификации в приложении.

   1. В настройках Salesforce в левой навигационной панели выберите Приложения > Менеджер приложений .
   2. В списке найдите созданное вами подключенное приложение.
   3. В раскрывающемся списке справа в строке приложения нажмите «Просмотр» .
   4. В разделе API (Включить параметры OAuth) найдите ключ потребителя и скопируйте его значение в безопасное место для использования при настройке расширения .

Настройте подключенное приложение для доступа через расширение

Прежде чем расширение Salesforce сможет получить доступ к Salesforce, вам необходимо создать подключенное приложение Salesforce, через которое расширение сможет подключаться к Salesforce.

В Salesforce подключенное приложение предоставляет внешним приложениям возможность подключаться к Salesforce через API.

Чтобы настроить подключенное приложение

1. Войдите в систему Salesforce .
2. Нажмите на значок шестеренки в правом верхнем углу, затем нажмите «Настройка» .
3. В навигационной панели слева разверните Приложения > Менеджер приложений .
4. На странице диспетчера приложений нажмите «Новое подключенное приложение» .
5. В разделе Basic Information заполните необходимые поля. Значения предназначены для бухгалтерского учета; они не используются расширением.
6. В разделе API (Включить параметры OAuth) установите флажок Включить параметры OAuth .
7. Хотя он не используется расширением, введите URL обратного вызова . Вы можете использовать http://localhost/ или какой-либо другой хост-заполнитель.
8. Установите флажок Использовать цифровые подписи .
9. В разделе «Использовать цифровые подписи» нажмите «Выбрать файл» , чтобы найти и загрузить файл salesforce.crt , который вы создали ранее.
10. В разделе «Выбранные области действия OAuth» добавьте следующее, чтобы они находились в разделе «Выбранные области действия OAuth» :
    • Доступ и управление вашими данными (API)
    • Выполнять запросы от вашего имени в любое время (refresh_token, offline_access)
11. Нажмите Сохранить . Если есть какие-либо ошибки, вам может потребоваться повторно сгенерировать и загрузить файл salesforce.crt .
12. На открывшейся странице приложения нажмите «Управление» .
13. На странице диспетчера приложений для только что созданного приложения нажмите «Изменить политики» .
14. В разделе «Политики OAuth» щелкните раскрывающийся список «Разрешенные пользователи» , затем щелкните «Одобренные администратором пользователи предварительно авторизованы» .
15. Нажмите «Сохранить» .
16. Вернувшись на страницу приложения, в разделе «Профили» нажмите «Управление профилями» .

17. На странице «Назначение профиля приложения» установите флажки для профилей пользователей, которые могут использовать это приложение.

    Обязательно выберите профиль, соответствующий пользователю, чье имя пользователя вы будете использовать при настройке расширения. Также убедитесь, что по крайней мере пользователи с правами системного администратора имеют доступ к этому приложению.

    Вы можете просмотреть настройки профиля пользователя в Salesforce. В области «Настройка» разверните «Пользователи» > «Пользователи» , найдите пользователя, которого будет представлять расширение, затем найдите его профиль в столбце «Профиль» .

18. Нажмите «Сохранить» .

О компании Salesforce

Salesforce — это платформа управления взаимоотношениями с клиентами (CRM). Управление взаимоотношениями с клиентами помогает компаниям понимать потребности своих клиентов и решать проблемы, лучше управляя информацией о клиентах и ​​взаимодействиями с ними — все на единой платформе, которая всегда доступна с любого рабочего стола или устройства.

Действия

вставлять

Вставьте записи как типы sObject .

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

Параметры запроса

Ответ

Массив results операции вставки.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

обновлять

Обновите записи отдела продаж.

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    {
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName"
    }
  ],
  "allOrNone": true
}]]></Input>

Параметры запроса

Ответ

Массив results , содержащий результаты обновления.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

забрать

Извлечь записи как sObjects по их идентификаторам. Возвращает все поля типа sObject.

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Параметры запроса

Ответ

Массив records sObjects, представленный как JSON. Обратите внимание, что все свойства объектов включены в JSON, даже если значение свойства равно null.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

запросSOQL

Выполните запрос к Salesforce.com с помощью языка объектных запросов Salesforce (SOQL) .

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

Параметры запроса

Ответ

Результаты запроса.

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

список

Список записей Salesforce.com. Возвращает все поля указанного типа sObject.

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

Параметры запроса

Ответ

Массив records , содержащий перечисленные sObjects в формате JSON.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

дель

Удалить записи с указанными идентификаторами.

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Параметры запроса

Ответ

Массив results , содержащий результаты операции.

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

получитьAccessToken

Получить токен доступа к API Salesforce.com. Может использоваться для запроса REST API.

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

Параметры запроса

Никто.

Ответ

Токен доступа в формате JSON.

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

Ссылка на конфигурацию

Используйте следующее при настройке и развертывании этого расширения для использования в прокси-серверах API.

Общие свойства расширения

Следующие свойства присутствуют для каждого расширения.

Свойства этого пакета расширения

Укажите значения для следующих свойств конфигурации, специфичных для этого расширения.