- Распечатать
To download the app, visit: Library
Введение
Salesforce - это облачная CRM-платформа, используемая в различных приложениях: от отслеживания лидов на продажу до управления заказами и запасами.
Назначение .
В этом документе подробно описывается коннектор REST API Salesforce, находящийся в библиотеке Tulip. После настройки эти функции коннектора могут быть использованы для получения, запроса и изменения данных Salesforce из приложения Tulip.
Документация API
Документацию по Salesforce REST API можно найти здесь. Обратите внимание, что некоторые функции коннекторов, включенные в эту статью, выполняют запросы с использованием языка SOQL (Salesforce Object Query Language), полный синтаксис которого задокументирован здесь.
Note: Salesforce supports a number of API across a variety of methods, the full list of which can be found here. This article and the Connectors to which it is related are built to use the Salesforce REST API.
Первая установка
Warning: generating the following values requires developer- or administrator-level permissions in Salesforce.
:::Аутентификация API Salesforce соответствует стандартам OAuth 2.0. Ниже описывается процесс генерации маркера обновления, который затем будет использоваться любым приложением Tulip App для получения маркера доступа, необходимого для успешного подключения к Salesforce.
- Создайте подключенное приложение в Salesforce. Для этого перейдите в раздел "Настройка" в Salesforce. Затем перейдите в раздел PLATFORM TOOLS >> Apps >> Connected Apps >> Manage Connected Apps.
- Создайте новое подключенное приложение. Включите: a. Все области, необходимые для вашего приложения, но не забудьте включить
refresh_token
. b. Выберите Enable OAuth Settings и введите URL обратного вызова в качествеhttps://login.salesforce.com/services/oauth2/success.
- После завершения нажмите Manage Consumer Details, чтобы увидеть ваши "Ключ потребителя" и "Секрет потребителя". Они будут использоваться позже.
- Теперь в Tulip откройте функцию коннектора [Setup] Get Auth Code URL. Скопируйте и вставьте "Ключ потребителя", созданный в шаге 3 выше, в качестве параметра запроса
client_id
. - "Запустите функцию коннектора.
- Обратите внимание, что в качестве "выхода" коннектора был сгенерирован URL. Вставьте этот URL в окно браузера.
- Заполните появившееся приглашение к аутентификации, чтобы успешно авторизовать Tulip для взаимодействия с вашим экземпляром Salesforce.
- В случае успеха ваш браузер должен перенаправить вас на новую страницу с надписью
Remote Access Application Authorization
. Код авторизации можно найти в URL этой страницы. Например, в URLhttps://login.salesforce.com/services/oauth2/success?code=asdf1234
код авторизации -asdf1234
. - Сохраните этот код авторизации. Обратите внимание, что код должен заканчиваться двумя символами равенства:
==
. Если код заканчивается на%3D%3D
, удалите эти символы и замените на==
. - Перейдите к функции [Setup] Get Refresh Token Tulip Connector Function. В параметрах запроса вставьте всю информацию, которая была собрана выше:
grant_type=
authorization_code
redirect_uri=
https://login.salesforce.com/services/oauth2/success
client_id=
ключ потребителя из шага 3 вышеclient_secret=
Секрет потребителя из Шага 3 вышеcode=
код авторизации из шага 9 выше.
- Запустите этот коннектор и сохраните
refresh_token
, который появится в ответе. - Наконец, перейдите к функции коннектора [Auth] Get Access Token. Заполните следующие параметры запроса:
grant_type=
код_авторизации
client_id=
ключ потребителя из шага 3 вышеclient_secret=
секрет потребителя из шага 3 вышеrefresh_token=
токен обновления из шага 10 выше.
- Запустите коннектор. Обратите внимание, что ответ содержит
access_token
, который отображается как выход. Сохраните коннектор, чтобы сохранить токен обновления.
Как только эта функция сможет сгенерировать токен доступа
, настройка будет завершена! Теперь этот access_token
можно использовать в любой последующей функции коннектора до тех пор, пока это позволяют настройки тайм-аута, настроенные на шаге 2.
Детали подключения Tulip
Чтобы ваши коннекторы могли взаимодействовать с Salesforce, введите субдомен вашего экземпляра Salesforce в качестве "Субдомена по умолчанию" в разделе "Детали подключения коннектора". Например, если экземпляр Salesforce находится по адресу sample.my.salesforce.com, то субдомен по умолчанию должен быть sample.my
.
Обратите внимание, что все приведенные здесь функции коннекторов созданы для работы с Salesforce REST API v46.0.
Функции коннекторов
Существует два основных типа коннекторов: коннекторы объектного типа и коннекторы типа запроса. Обратите внимание, что оба коннектора требуют токен доступа
, поэтому не забудьте выполнить [Auth] Get Access Token в вашем приложении перед их использованием! Обычно рекомендуется генерировать новый токен доступа при запуске приложения или процесса и сохранять его в переменной App Variable для последующего использования.
Коннекторы типов объектов
- Возвращают все поля рассматриваемого объекта.
- Используйте конечную точку
./services/data/v46.0/sobjects/<Имя объекта>/<Идентификатор объекта>
. - Пример: Коннектор [Opportunity] Получить все поля
Коннекторы типа запроса
- Возвращают только поля, указанные в запросе.
- Могут возвращать связанную (например, имя счета, связанное с возможностью) или агрегированную (например, подсчет записей) информацию.
- Используется конечная точка
./services/data/v46.0/query
- Требуется написать запрос с использованием SOQL (документация
здесь{target=_blank}
). - Пример: Коннектор [Заказ] Получить все заказы со статусом
Включенные функции коннектора
Следующие функции коннектора включены в этот пакет и предназначены для ознакомления с функциями, возможными через Salesforce API:* [Setup] Get Auth Code URL & [Setup] Get Refresh Token * Используется только при первой настройке. Дополнительную информацию см. выше.* [Auth] Get Access Token * Используется для генерации токена доступа, который должен быть включен во все последующие функции коннектора.* Функции [Opportunity]: * Get All Fields * Возвращает все поля запрашиваемой возможности. Требуется токен доступа и идентификатор возможности. * Change Stage * Обновление стадии указанной возможности до указанного значения.* [Order] functions: * Get All Orders of Status * Возвращает список всех заказов указанного статуса. * Count Orders of Status * Возвращает подсчет всех заказов указанного статуса. * Get Order Number from ID * Возвращает номер заказа по указанному идентификатору заказа.
Чтобы изменить эти функции в соответствии с вашими потребностями, обратите внимание на следующие советы: 1. Чтобы изменить функции коннектора объектного типа, просто измените объект, указанный в URL. При необходимости добавьте или удалите новые выходы.2. Для модификации функций коннектора типа запроса все изменения должны быть сделаны в запросе. Его можно найти в Параметрах запроса с ключом q
. 1. Совет: ограничьте количество ответов в запросе с помощью функции LIMIT(number_of_responses).
Вы нашли то, что искали?
Вы также можете зайти на community.tulip.co, чтобы задать свой вопрос или узнать, сталкивались ли другие с подобным вопросом!