使用上限设置API

简介

Journey Orchestration的API支持5000事件/秒，但某些外部系统或API无法具有同等的吞吐量。因此，Journey Orchestration附带一个名为Capping API的专用功能，用于监视和限制我们对外部系统施加的速率。

在数据源配置过程中，您将定义到系统的连接以检索将在您的旅程中使用的其他信息，或者为操作定义，您将配置第三方系统的连接以发送消息或API调用。 每次由历程执行API调用时，将查询上限API，调用将通过API引擎进行。 如果定义了限制，则会拒绝该调用，并且外部系统不会过载。

要了解有关操作或数据源配置的详细信息，请参阅关于操作或关于数据源

资源

要将此API与您的Journey Orchestration实例一起使用，您需要使用AdobeI/O控制台。 您可以按照以下步骤进行开始:Adobe开发者控制台快速入门，然后使用本页中的部分。

要测试和准备集成，此处提供了Postman集合。

身份验证

设置 API 访问

Journey Orchestration 通过以下步骤设置API访问。Adobe I/O文档中详细介绍了这些步骤中的每个步骤。

1. 请检查您是否有数字证书，或根据需要创建数字证书。在以下步骤中需要随证书提供的公钥和私钥。
2. 创建与ServiceinAdobe I/O的 Journey Orchestration 新集成并配置它。Journey Orchestration和Adobe Experience Platform需要产品用户档案访问。 随后将生成您的凭据（API密钥、客户端机密……）。
3. 从先前生成的凭据创 建JSON Web令牌(JWT)，然后使用私钥对其进行签名。JWT对Adobe验证您的身份和授予您对API的访问权限所需的所有身份和安全信息进行编码。 此步骤详见此节
4. 通过POST请求或通过开 发人员控制台界面将JWT交换为访问令牌。此访问令牌必须用于API请求的每个标头。

要建立安全的服务对服务Adobe I/OAPI会话，对Adobe服务的每个请求都必须在授权标头中包含以下信息。

curl -X GET https://journey.adobe.io/authoring/XXX \
 -H 'Authorization: Bearer <ACCESS_TOKEN>' \
 -H 'x-api-key: <API_KEY>' \
 -H 'x-gw-ims-org-id: <ORGANIZATION>'

• <organization>:这是您的个人组织ID，Adobe为每个实例提供一个组织ID:

  • <organization> :您的生产实例

  要获取您的组织ID值，请咨询您的管理员或您的Adobe技术联系人。 您还可以在许可证列表(请参阅Adobe I/O文档)中创建新集成时，将其检索到Adobe I/O中。

• <access_token>:您的个人访问令牌，通过POST请求交换JWT时已检索到。

• <api_key>:您的个人API密钥。它在创建到Journey Orchestration服务的新集成后以Adobe I/O形式提供。

限制API描述

上限设置API可帮助您创建、配置和监控您的上限设置配置。

创建或更新配置时，将自动执行检查以保证有效负荷的语法和完整性。
如果出现某些问题，操作会返回警告或错误以帮助您更正配置。

端点配置

下面是端点配置的基本结构：

{
    "url": "<endpoint URL>",  //wildcards are allowed in the endpoint URL
    "methods": [ "<HTTP method such as GET, POST, >, ...],
    "services": {
        "<service name>": { . //must be "action" or "dataSource" 
            "maxHttpConnections": <max connections count to the endpoint>
            "rating": {          
                "maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
                "periodInMs": <integer value greater than 0>
            }
        },
        ...
    }
}

示例:

`{
  "url": "https://api.example.org/data/2.5/*",
  "methods": [
    "GET"
  ],
  "services": {
    "dataSource": {
      "maxHttpConnections": 30000,
      "rating": {
        "maxCallsCount": 5000,
        "periodInMs": 1000
      }
    }
  },
  "orgId": "<IMS Org Id>"
}

警告和错误

当调用​canDeploy​方法时，该进程验证配置并返回由其唯一ID标识的验证状态，其中任一项：

"ok" or "error"

潜在错误有：

• ERR_ENDPOINTCONFIG_100:上限配置：缺少或无效url
• ERR_ENDPOINTCONFIG_101:上限配置：格式错误
• ERR_ENDPOINTCONFIG_102:上限配置：格式错误的url:host:port中不允许在url中使用通配符
• ERR_ENDPOINTCONFIG_103:上限配置：缺少HTTP方法
• ERR_ENDPOINTCONFIG_104:上限配置：未定义呼叫等级
• ERR_ENDPOINTCONFIG_107:上限配置：max调用计数无效(maxCallsCount)
• ERR_ENDPOINTCONFIG_108:上限配置：最大调用计数无效(periodInMs)
• ERR_ENDPOINTCONFIG_111:上限配置：无法创建终结点配置：无效负载
• ERR_ENDPOINTCONFIG_112:上限配置：无法创建终结点配置：应为JSON有效负荷
• ERR_AUTHORING_ENDPOINTCONFIG_1:服务名无效 <!--<given value>-->:必须为'dataSource'或'action'

潜在的警告是：

ERR_ENDPOINTCONFIG_106:上限配置：未定义最大HTTP连接数：默认情况下不限制

用例

在本节中，您将找到在Journey Orchestration中管理上限配置时可执行的五个主要用例。

为了帮助您进行测试和配置，此处提供了Postman集合。

此Postman集合已设置为共享通过​Adobe I/O控制台的Integrations > Try out > Download for Postman​生成的Postman变量集合，该集合生成具有选定集成值的Postman环境文件。

下载并上传到Postman后，您需要添加三个变量：{JO_HOST}、{Base_Path}和{SANDBOX_NAME}。

• {JO_HOST} : Journey Orchestration 网关URL
• {BASE_PATH} :API的入口点。值为“/authoring”
• {SANDBOX_NAME} :与执 行API操作的沙箱名 称相对应的标头x-sandbox-name（例如，“prod”）。有关详细信息，请参阅沙箱概述。

在以下部分中，您将找到Rest API调用的排序列表以执行用例。

用例n°1:创建和部署新的上限配置

1. 列表
2. create
3. candeploy
4. 部署

用例n°2:更新和部署尚未部署的上限配置

1. 列表
2. 获取
3. 更新
4. candeploy
5. 部署

用例n°3:取消部署和删除已部署的上限配置

1. 列表
2. 取消部署
3. 删除

用例n°4:删除已部署的上限配置。

在仅一个API调用中，可以使用forceDelete参数取消部署和删除配置。

1. 列表
2. 删除，使用forceDelete参数

用例n°5:更新已部署的上限配置

1. 列表
2. 获取
3. 更新
4. 取消部署
5. candeploy
6. 部署