Коннектор Salesforce

Additional Configuration Required

This connector is a good starting point that implements a core set of the service's most common functions. You should expect to extend it by adding functions for the specific endpoints your workflow requires. Additionally, some configuration may be required in Salesforce to establish a connection with Tulip. Please review our [connectors](/r230/docs/<span translate=)">connector framework to learn more about how to build and modify connectors in Tulip.

To download the app, visit: [connectors](https://tulip.co/library/<span translate=)/salesforce-connector/">Library

Введение

Salesforce — это облачная программная платформа CRM, используемая в различных приложениях — от отслеживания потенциальных клиентов до управления заказами и запасами.

Цель

В данном документе подробно описан коннектор REST API для Salesforce, доступный в библиотеке Tulip. После настройки эти функции коннектора можно использовать для извлечения, запроса и изменения данных Salesforce из приложения Tulip.

Документация по API

Документацию по REST API Salesforce можно найти здесь. Обратите внимание, что некоторые функции коннектора, описанные в данной статье, выполняют запросы с использованием SOQL (Salesforce Object Query Language), полный синтаксис которого описан здесь.

API Variations

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.

Первоначальная настройка

Permissions Warning

Warning: generating the following values requires developer- or administrator-level permissions in Salesforce.

Аутентификация по API Salesforce соответствует стандартам OAuth 2.0. В описанном ниже процессе объясняется, как сгенерировать токен обновления, который затем будет использоваться любым приложением Tulip для получения токена доступа, необходимого для успешного подключения к Salesforce.

Создайте подключенное приложение в Salesforce. Для этого перейдите в раздел «Настройка» в Salesforce. Затем перейдите в «ИНСТРУМЕНТЫ ПЛАТФОРМЫ» >> «Приложения» >> «Подключенные приложения» >> «Управление подключенными приложениями».
Создайте новое подключённое приложение. Укажите: a. все области доступа, требуемые вашим приложением, но обязательно включите refresh_token. b. Выберите «Включить настройки OAuth» и введите URL обратного вызова в виде https://login.salesforce.com/services/oauth2/success.
По завершении нажмите «Управление данными потребителя », чтобы увидеть «Ключ потребителя» и «Секретный ключ потребителя». Они понадобятся позже.
Теперь в Tulip откройте URL-адрес Connector Function [Настройка] Получить код авторизации. Скопируйте и вставьте «Ключ потребителя», сгенерированный в шаге 3 выше, в качестве параметра запроса client_id.
«Запустите» коннектор « Connector Function ».
Обратите внимание, что в качестве «Вывода» коннектора был сгенерирован URL-адрес. Вставьте этот URL-адрес в окно браузера.
Выполните появившееся запрос на аутентификацию, чтобы успешно авторизовать Tulip для взаимодействия с вашим экземпляром Salesforce.
В случае успеха ваш браузер должен перенаправить вас на новую страницу с надписью «Авторизация приложения удаленного доступа». Код авторизации можно найти в URL-адресе этой страницы. Например, в URL-адресе https://login.salesforce.com/services/oauth2/success?code=asdf1234 кодом авторизации является asdf1234.
Сохраните этот код авторизации. Обратите внимание, что код должен заканчиваться двумя символами равенства: ==. Если код заканчивается на %3D%3D, удалите эти символы и замените их на ==.
Перейдите в раздел [Настройка] «Получить токен обновления» на сайте 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] Получить токен доступа Connector Function. Заполните следующие параметры запроса:
- grant_type= authorization_code
- client_id= ключ потребителя из шага 3 выше
- client_secret= секретный ключ потребителя из шага 3 выше
- refresh_token = токен обновления из шага 10 выше
Запустите коннектор. Обратите внимание, что в ответе содержится access_token, который отображается в качестве выходных данных. Сохраните коннектор, чтобы сохранить токен обновления

Как только эта функция сможет сгенерировать access_token, настройка будет завершена! Этот access_token теперь можно использовать в любом последующем запросе Connector Function в течение времени, предусмотренного настройками таймаута, заданными в шаге 2.

Детали подключения к Tulip

Чтобы ваши коннекторы могли взаимодействовать с Salesforce, введите субдомен вашего экземпляра Salesforce в поле «Default Subdomain» (Субдомен по умолчанию) в разделе «Connection Details» (Сведения о подключении) коннектора. Например, если экземпляр Salesforce находится по адресу sample.my.salesforce.com, то субдоменом по умолчанию должен быть sample.my.

Обратите внимание, что все коннекторы Connector Functions здесь созданы для работы с REST API Salesforce версии 46.0.

Connector Functions

Существует два основных типа коннекторов: коннекторы объектного типа и коннекторы типа запроса. Обратите внимание, что обоим коннекторам требуется access_token, поэтому перед их использованием обязательно запустите в приложении операцию [Auth] Get Access Token! Обычно рекомендуется генерировать новый токен доступа при запуске приложения или процесса и сохранять его в переменной приложения для дальнейшего использования.

Коннекторы объектного типа

Возвращают все поля рассматриваемого объекта.
Используйте конечную точку ./services/data/v46.0/sobjects/<название объекта>/<идентификатор объекта>
Пример: коннектор [Opportunity] Get All Fields

Коннекторы типа «Запрос»

Возвращают только те поля, которые указаны в запросе.
Могут возвращать связанную (например, название учетной записи, связанной с возможностью) или агрегированную (например, количество записей) информацию.
Используйте конечную точку ./services/data/v46.0/query
Требуется написание запроса с использованием SOQL (документация здесь{target=_blank}).
Пример: Коннектор [Order] Получить все заказы со статусом

Включено Connector Functions

В данный пакет включены следующие конечные точки ( Connector Functions ), которые призваны служить введением в функции, доступные через API Salesforce:* [Setup] Получить URL-адрес для авторизации и [Setup] Получить токен обновления * Используются только при первоначальной настройке. Дополнительную информацию см. выше.*[Auth] Получить токен доступа * Используется для генерации токена доступа, который должен включаться во все последующие запросы Connector Functions.* Функции [Opportunity]: * Получить все поля * Возвращает все поля запрошенной возможности. Требует токена доступа и ID возможности. * Изменить этап * Обновляет этап указанной возможности до заданного значения.* Функции [Order]: * Получить все заказы с статусом * Возвращает список всех заказов с указанным статусом. * Подсчитать количество заказов с статусом * Возвращает количество всех заказов с указанным статусом. * Получить номер заказа по ID * Возвращает номер заказа по указанному ID заказа.

Чтобы изменить эти функции в соответствии с вашими потребностями, обратите внимание на приведенные ниже рекомендации: 1. Чтобы изменить запрос типа «объект» ( Connector Functions), просто измените объект, указанный в URL-адресе. При необходимости добавляйте или удаляйте новые выводы. 2. Чтобы изменить запрос типа Connector Functions, все изменения необходимо внести в сам запрос. Его можно найти в параметрах запроса с ключом q. 1. Совет: ограничьте количество ответов от запроса с помощью функции LIMIT(количество_ответов)

Нашли ли вы то, что искали?

Вы также можете перейти на сайт community.tulip.co, чтобы задать свой вопрос или посмотреть, сталкивались ли другие пользователи с похожей проблемой!