Коннектор Salesforce

::: (информация) () Чтобы скачать приложение, посетите: Библиотека:::

Введение

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

Назначение .

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

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

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

:::(Info) (Разновидности API) Примечание: Salesforce поддерживает ряд API с использованием различных методов, полный список которых можно найти здесь.
Эта статья и коннекторы, к которым она относится, построены для использования Salesforce REST API.
:::

Первая установка

:::(Warning) (Предупреждение о разрешениях) Предупреждение: для генерации следующих значений требуются разрешения уровня разработчика или администратора в Salesforce. ::: Аутентификация API Salesforce соответствует стандартам OAuth 2.0. Ниже описывается процесс генерации маркера обновления, который затем будет использоваться любым приложением Tulip App для получения маркера доступа, необходимого для успешного подключения к Salesforce.

1. Создайте подключенное приложение в Salesforce. Для этого перейдите в раздел "Настройка" в Salesforce. Затем перейдите в раздел PLATFORM TOOLS >> Apps >> Connected Apps >> Manage Connected Apps.
2. Создайте новое подключенное приложение. Включите в него:
   a. Все диапазоны, требуемые вашим приложением, но не забудьте включить refresh_token. b. Выберите Enable OAuth Settings и введите URL-адрес обратного вызова как https://login.salesforce.com/services/oauth2/success.
3. После завершения нажмите Manage Consumer Details, чтобы увидеть ваши "Ключ потребителя" и "Секрет потребителя". Они будут использоваться позже.
4. Теперь в Tulip откройте функцию коннектора [Setup] Get Auth Code URL. Скопируйте и вставьте "Ключ потребителя", созданный в шаге 3 выше, в качестве параметра запроса client_id.
5. "Запустите функцию коннектора.
6. Обратите внимание, что в качестве "выхода" коннектора был сгенерирован URL. Вставьте этот URL в окно браузера.
7. Заполните появившееся приглашение к аутентификации, чтобы успешно авторизовать Tulip для взаимодействия с вашим экземпляром Salesforce.
8. В случае успеха ваш браузер должен перенаправить вас на новую страницу с надписью Remote Access Application Authorization. Код авторизации можно найти в URL этой страницы.
   Например, в URL https://login.salesforce.com/services/oauth2/success?code=asdf1234 код авторизации - asdf1234.
9. Сохраните этот код авторизации. Обратите внимание, что код должен заканчиваться двумя символами равенства: ==. Если код заканчивается на %3D%3D, удалите эти символы и замените на ==.
10. Перейдите к функции [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 выше
11. Запустите этот коннектор и сохраните refresh_token, который появится в ответе.
12. Наконец, перейдите к функции коннектора [Auth] Get Access Token. Заполните следующие параметры запроса:
    • grant_type= код_авторизации
    • client_id= ключ потребителя из шага 3 выше
    • client_secret= секрет потребителя из шага 3 выше
    • refresh_token= токен обновления из шага 10 выше
13. Запустите коннектор. Обратите внимание, что ответ содержит 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 (документация here{target=_blank}).
• Пример: Коннектор [Заказ] Получить все заказы с определенным статусом

Включенные функции коннектора

Следующие функции коннектора включены в этот пакет и предназначены для ознакомления с функциями, возможными через Salesforce API: * [Setup] Get Auth Code URL & [Setup] Get Refresh Token * Используется только при первой настройке. Дополнительную информацию см. выше.* [Auth] Get Access Token * Используется для генерации токена доступа, который должен быть включен во все последующие функции коннектора.* Функции [Opportunity]:
* Get All Fields (Получить все поля) * Возвращает все поля запрашиваемой возможности. Требуется токен доступа и идентификатор возможности.* Change Stage * Обновление стадии указанной возможности до указанного значения.* Функции [Order]: * Get All Orders of Status * Возвращает список всех заказов указанного статуса.* Count Orders of Status * Возвращает счетчик всех заказов указанного статуса.* Get Order Number from ID * Возвращает номер заказа из указанного идентификатора заказа.

Чтобы изменить эти функции в соответствии с вашими потребностями, обратите внимание на следующие советы:

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

Вы нашли то, что искали?

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