Расширение Salesforce

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

Версия: 2.0.2

получать доступ к данным в вашем аккаунте 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. В разделе Основная информация заполните обязательные поля. Эти значения нужны для учета и не используются расширением.
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). Система управления взаимоотношениями с клиентами (CRM) помогает компаниям лучше понимать потребности клиентов и решать их проблемы, эффективно управляя информацией о клиентах и взаимодействиях с ними на единой платформе, доступной с любого компьютера или устройства.

Действия

insert

Вставляйте записи как типы объектов 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: [] }
  ]
}

update

Обновлять записи Salesforce.

<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: [] }
  ]
}

возвращение

Получайте записи в виде объектов SObject по их идентификаторам. Возвращает все поля типа 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 объектов sObject, представленных в формате JSON. Обратите внимание, что в JSON включаются все свойства объектов, даже если значение свойства равно null.

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

querySOQL

Запрашивать данные у 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
}

list

Список записей 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, содержащий перечисленные объекты sObject в формате JSON.

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

del

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

<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: [] }
  ]
}

getAccessToken

Получите токен доступа к 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 следуйте приведенным ниже инструкциям.

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

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

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

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