从 REST API 调用集成程序

使用 REST API，您可以使用 GET 或 POST 调用来调用集成程序并检索结果。两者之间的区别是 GET 调用不能通过 JSON 请求正文传递数据。

您可以使用以下格式的 URL 调用 REST 调用：

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/

命名空间通常是 omnistudio。指定集成程序的类型和子类型。

您可以使用参数以三种方式将数据传递到集成程序：

• 作为 URL 路径中的内联值（GET 或 POST）

• 作为 query parameter=value 对附加到 URL（GET 或 POST）

• 通过指定 JSON 请求正文（仅限 POST）

备注

在将集成程序与 REST API 一起使用时，请遵循以下准则：

• 在 JSON 符号中，花括号是文字。它们分隔 JSON 对象。

• 在 REST URL 符号中，花括号会围绕您必须替换的变量值。请勿在实际请求中包含括号。

• 将 REST URL 的所有部分区分大小写。

您还可以通过 REST 调用将集成程序选项（例如chainable或queueableChainable）设置为查询参数：

/services/apexrest/vlocity_ins/v1/integrationprocedure/Create_Cases/?queueableChainable=true

有关对集成程序的 REST 调用的示例，请参见使用 REST 调用调用可链集成程序。

• 使用 GET 进行集成程序调用
  要从集成程序请求和接收 JSON 数据结果，请发出 GET 调用。通过 GET 调用，您可以指定内联 URL 路径参数，并将查询参数附加到 URL。如果您必须使用 JSON 请求正文传递数据，请改用 POST 调用。
• 使用 POST 调用集成程序
  要将 JSON 数据发送到集成程序并从中接收结果，请发出 POST 调用。通过 POST 调用，您可以指定内联 URL 路径参数，将查询参数附加到 URL，并包含 JSON 请求正文。

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}

/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneX

{
  "options": {
    "Path1": "Apple",
    "Path2": "Phones",
    "product": "iPhoneX",
    "isDebug": "true"
  }

}

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/{inlinevalue1}/{inlinevalue2}/?{Param1}={Value1}

/services/apexrest/vlocity_cmt/v1/integrationprocedure/IP_Rest/Apple/Phones/?product=iPhoneX

{
  "options": {
    "Path1": "Apple",
    "Path2": "Phones",
    "product": "iPhoneX",
    "isDebug": "true"
  }
}