- 打印
::(信息)()要下载应用程序,请访问:图书馆:::
简介
Salesforce 是一个基于云的客户关系管理软件平台,可用于从销售线索跟踪到订单和库存管理等各种应用中。
目的
本文档详细介绍了郁金香库中的 Salesforce REST API 连接器。配置完成后,这些连接器功能可用于从 Tulip 应用程序检索、查询和修改 Salesforce 数据。
应用程序接口文档
有关 Salesforce REST API 的文档可在此处找到。请注意,本文中的某些连接器函数使用 SOQL(Salesforce 对象查询语言)完成查询,其完整语法在此处有详细说明。
:::(Info) (API 变体)注:Salesforce 支持多种方法的 API,完整列表可在此处找到。
本文及其相关的连接器是为使用Salesforce REST API而构建的。
:::
首次设置
:::(Warning) (权限警告)警告:在 Salesforce 中生成以下值需要开发人员或管理员级别的权限。 ::: Salesforce API 身份验证遵循 OAuth 2.0 标准。 以下流程概述了如何生成刷新令牌,然后任何 Tulip 应用程序都将使用该令牌检索成功连接到 Salesforce 所需的访问令牌。
- 在 Salesforce 中创建一个连接应用程序。为此,请导航到 Salesforce 的 "设置 "空间。然后,导航至平台工具 >> 应用程序 >> 连接的应用程序 >> 管理连接的应用程序。
- 创建一个新的连接应用程序。包括
b. 选择启用 OAuth 设置,并输入回调 URL 作为https://login.salesforce.com/services/oauth2/success
。
- 完成后,单击 "管理消费者详细信息"查看 "消费者密钥 "和 "消费者秘密"。稍后将使用这些信息。
- 现在在 Tulip 中打开连接器功能**[设置] 获取 Auth 代码 URL**。复制并粘贴上述步骤 3 中生成的 "消费者密钥",作为查询参数
client_id
。 - "运行 "连接器函数。
- 观察连接器的 "输出",会生成一个 URL。将该 URL 粘贴到浏览器窗口中。
- 完成出现的验证提示,成功授权 Tulip 与 Salesforce 实例交互。
- 如果成功,浏览器会重定向到一个新页面,上面写着 "
远程访问应用程序授权
"。授权代码可以在该页面的 URL 中找到。
例如,在 URLhttps://login.salesforce.com/services/oauth2/success?code=asdf1234
中,授权代码为asdf1234
。 - 保存此授权代码。请注意,代码必须以两个等号结尾:
==
。 如果代码以%3D%3D
结尾,请删除这些字符并替换为==
。 - 导航到**[设置] 获取刷新令牌**郁金香连接器功能。在 "查询参数 "中,粘贴上面收集的所有信息:
grant_type=
授权代码
redirect_uri=
https://login.salesforce.com/services/oauth2/success
client_id=
上文步骤 3 中的消费者密钥client_secret=
上述步骤 3 中的用户密钥code=
上述步骤 9 中的授权代码
- 运行此连接器,并保存响应中显示的
refresh_token
文件。 - 最后,导航到**[Auth] 获取访问令牌**连接器函数。填写以下查询参数:
grant_type=
授权代码
client_id=
上述步骤 3 中的消费者密钥client_secret=
上述步骤 3 中的用户密钥refresh_token=
上述步骤 10 中的刷新令牌
- 运行连接器。请注意,响应包括一个
access_token
,它被映射为输出。保存连接器以保存刷新令牌
一旦该函数能够生成访问
令牌,设置就完成了!现在,只要步骤 2 中配置的超时设置允许,该access_token
就可以在任何后续 Connector 函数中使用。
郁金香连接细节
要使连接器与 Salesforce 接口,请在连接器的连接详细信息下输入 Salesforce 实例的子域作为 "默认子域"。
例如,如果 Salesforce 实例位于 sample.my.salesforce.com,则默认子域应为sample.my
。
请注意,此处的所有连接器功能都是为与 Salesforce REST API v46.0 配合使用而构建的。
连接器功能
连接器主要有两种类型:对象类型连接器和查询类型连接器。
请注意,这两种连接器都需要访问令牌
,因此在使用前请确保在应用程序中运行**[Auth] Get Access Token**!通常建议在应用程序或进程启动时生成一个新的访问令牌,并将其保存到应用程序变量中以便以后使用。
对象类型连接器
- 返回相关对象的所有字段。
- 使用端点
./services/data/v46.0/sobjects/<Object Name>/<Object ID>
- 示例连接器**[机会] 获取所有字段**
查询类型连接器
- 仅返回查询中指定的字段。
- 可返回链接信息(如与机会相关的账户名称)或汇总信息(如记录计数)。
- 使用端点
./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] functions:
* 获取所有字段 *返回所查询机会的所有字段。需要访问令牌和机会 ID。* Change Stage *将指定机会的阶段更新为指定值。 * [Order] functions: * Get All Orders of Status * Returnsa listof all Orders of a specified Status. * Count Orders of Status * Returns a count of all Orders of a specified Status*.* Get Order Number from ID * Returns an OrderNumber from*a specified Order ID.
要修改这些函数以满足您的需要,请注意以下建议:
1.要修改对象类型连接器函数,只需更改 URL 中指示的对象。根据需要添加或删除新的输出。要修改查询类型的连接器功能,必须在查询中进行所有更改。这可以在查询参数中找到,关键字是q
。
1.提示:使用函数 LIMIT(number_of_responses) 限制查询的回复数。
找到要找的内容了吗?
您还可以前往community.tulip.co发布您的问题,或查看其他人是否遇到过类似问题!