如何使用用户定义的凭据类型
添加 Web 服务数据操作集成时,可以选择凭据类型: 基本身份验证、用户定义或用户定义 (OAuth)。 有关更多信息,请参阅 添加数据操作集成 和 凭据类型。
本文介绍了如何使用用户定义的凭据类型。
- 添加集成时,请配置用户定义的凭据。
为您正在使用的 API 添加字段名称以及这些字段名称的值。
- 在您创建的所有自定义操作的请求中使用凭据中的字段名称。
以下示例是一个名为 “获取天气” 的自定义操作的请求。 凭证 是一个静态关键字,可以与其他 Velocity 宏一起使用。 API_Key 是您添加到凭证配置中的字段名称。 有关详细信息,请参阅数据操作的 Velocity 宏。
尽管集成会对字段名称的值进行编辑,但实际值会显示在 Web 服务中。 例如,如果 API_Key 的值 为 12345,那么当操作执行时,您在 Web 服务中看到的 requestURLTemplate 为 “https://api.openweathermap.org/data/2.5/weather?q=London&APPID=12345”。 有关更多信息,请参阅 创建自定义操作、向自定义操作 添加配置和 请求配置。
警告: 请务必在请求 模板、 成功模板或 requestURLTemplate中避免任何对输入或输出变量的使用。 如果没有使用特殊字符正确转义变量,则数据操作将在执行时失败。- 使用 esc.jsonString 来转义 JSON 正文中的字符串。
有关更多信息,请参阅 Velocity 宏中的 ESC.jsonString 部分了解数据操作。
- 如果使用 x-www.form- urlen编码的值, 请使用 esc.url () 或 URLtool.OptionalQueryParam () 来正确转义 请求 URL 模板 或请求模板的路径或查询参 数。
有关更多信息,请参阅 Velocity 宏中的字符串转义库部分以了解数据操作。
由于转义是特定于 JSON 上下文的,因此以下示例故意不显示转义。
{ "requestUrlTemplate": "https://api.openweathermap.org/data/2.5/weather?q=London&APPID=${credentials.API_Key}", "requestType": "GET", "headers": {}, "requestTemplate": "${input.rawRequest}" }
注意: 当您测试自定义操作时,集成会编辑所有授权信息。 有关更多信息,请参阅 测试自定义操作。 - 使用 esc.jsonString 来转义 JSON 正文中的字符串。
有关集成的详细信息,请参阅 关于 Web 服务数据操作集成。