Salesforce 连接器

Prev Next
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 软件平台,应用范围涵盖从销售线索跟踪到订单和库存管理等多个领域。

目的

本文档详细介绍了 Tulip 库中的 Salesforce REST API 连接器。配置完成后,这些连接器函数可用于从 Tulip 应用中检索、查询和修改 Salesforce 数据。

API 文档

Salesforce REST API 的文档可在此处查阅。请注意,本文中包含的某些连接器函数使用 SOQL(Salesforce 对象查询语言)执行查询,其完整语法文档请参见此处。

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.

Salesforce API 身份验证遵循 OAuth 2.0 标准。以下流程概述了如何生成刷新令牌,任何 Tulip 应用都将使用该刷新令牌来获取成功连接到 Salesforce 所需的访问令牌。

  1. 在 Salesforce 中创建一个“连接应用”。操作步骤如下:进入 Salesforce 的“设置”区域,然后依次导航至**“平台工具”>>“应用”>>“连接应用”>>“管理连接应用”**。
  2. 创建一个新的“连接应用”。请包含: a. 您的应用所需的任何权限范围,但务必包含refresh_token。 b. 选中**“启用 OAuth 设置**”,并将回调 URL 设置为https://login.salesforce.com/services/oauth2/success。
  3. 完成后,点击**“管理消费者详细信息”**以查看您的“消费者密钥”和“消费者密钥密文”。这些信息将在后续步骤中使用。
  4. 现在在 Tulip 中,打开Connector Function [设置] 获取授权码 URL。复制并粘贴上文第 3 步中生成的“消费者密钥”作为查询参数client_id。
  5. “运行”该Connector Function 。
  6. 请注意,连接器的“输出”中已生成一个 URL。将此 URL 粘贴到浏览器窗口中。
  7. 完成弹出的身份验证提示,以成功授权 Tulip 与您的 Salesforce 实例进行交互。
  8. 如果成功,您的浏览器应重定向到一个显示“远程访问应用程序授权”的新页面。授权码可在该页面的 URL 中找到。 例如,在 URLhttps://login.salesforce.com/services/oauth2/success?code=asdf1234中,授权码为asdf1234。
  9. 请保存此授权码。请注意,该代码必须以两个等号==结尾。如果代码以%3D%3D 结尾,请删除这些字符并替换为==。
  10. 导航至**[设置] 获取刷新令牌**TulipConnector 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] 获取访问令牌** Connector Function 。填写以下查询参数:
    • grant_type= authorization_code
    • client_id= 上述第 3 步中的消费者密钥
    • client_secret= 上文第 3 步中的消费者密钥
    • refresh_token= 上文第 10 步中的刷新令牌
  13. 运行连接器。请注意,响应中包含一个access_token,该值已被映射为输出。保存连接器以保存刷新令牌

一旦该函数能够生成access_token,即表示设置完成!此后,在第 2 步中配置的超时设置允许的时间范围内,该access_token可在任何后续的Connector Function 中使用。

Tulip 连接详细信息

要使连接器能够与 Salesforce 对接,请在连接器的**“连接详细信息**”下,将您的 Salesforce 实例的子域名输入为“默认子域名”。 例如,如果 Salesforce 实例位于 sample.my.salesforce.com,则默认子域名应为sample.my.

请注意,此处的所有Connector Functions 均设计为与Salesforce REST API v46.0兼容。

Connector Functions

连接器主要有两种类型:对象型和查询型连接器。 请注意,这两种连接器都需要access_token,因此请务必在执行这些操作之前,在您的应用中运行**[Auth] 获取访问令牌**!通常建议在应用或流程启动时生成一个新的访问令牌,并将其保存到应用变量中以备后用。

对象型连接器

  • 返回目标对象的所有字段。
  • 使用端点./services/data/v46.0/sobjects/<对象名称>/<对象 ID>
  • 示例:连接器**[Opportunity] 获取所有字段**

查询型连接器

  • 仅返回查询中指定的字段。
  • 可以返回关联信息(例如与商机相关的账户名称)或汇总信息(例如记录的数量)。
  • 使用端点./services/data/v46.0/query
  • 需要使用 SOQL 编写查询(文档请参见此处{target=_blank})。
  • 示例:连接器**[订单] 获取所有状态为**

包含内容Connector Functions

本包中包含以下Connector Functions ,旨在作为 Salesforce API 可用功能的入门指南:* [Setup] 获取授权码 URL 和 [Setup] 获取刷新令牌 *仅用于首次设置。更多信息请参见上文。*[Auth] 获取访问令牌 *用于生成访问令牌,此后所有Connector Functions 调用中都必须包含该令牌 。 *[Opportunity] 函数: * 获取所有字段 *返回所查询商机的所有字段。需要访问令牌和商机 ID。 * 更改阶段 *将指定商机的阶段更新为指定值。*[订单] 函数: * 获取状态为 的所有订单 *返回状态为 的所有订单列表。 * 统计状态为 的订单数量 *返回状态为 的所有订单数量。 * 根据 ID 获取订单号 *根据指定的订单 ID 返回订单号。

若要根据您的需求修改这些函数,请注意以下建议:1. 要修改对象类型的Connector Functions ,只需更改 URL 中指定的对象即可。 根据需要添加或删除新的输出项。2. 要修改查询类型的Connector Functions ,所有更改都必须在查询中进行。该查询位于**“查询参数**”中,键名为q。 1.提示:使用函数 LIMIT(number_of_responses) 限制查询的响应数量


您找到想要的内容了吗?

您也可以访问community.tulip.co发布问题,或查看其他人是否遇到过类似问题!