Journey Orchestrations API支持5000事件/秒,但某些外部系统或API无法具有同等的吞吐量。因此,Journey Orchestration附带一个名为Capping API的专用功能,用于监视和限制我们对外部系统的速率。
在数据源配置过程中,您将定义到系统的连接以检索将在您的旅程中使用的其他信息,或者为操作定义,您将配置第三方系统的连接以发送消息或API调用。 每次由旅程执行API调用时,将查询限制API,该调用将通过API引擎进行。 如果定义了限制,则会拒绝该调用,并且外部系统不会过载。
要了解有关操作或数据源配置的更多信息,请参阅关于操作或关于数据源
在此处可用的Swagger文件中描述了Journey Orchestration限制API。
要将此API用于Journey Orchestration实例,您需要使用AdobeI/O控制台。 您可以按照此Adobe开发者控制台快速入门进行开始,然后使用本页中的各节。
要测试和准备集成,此处提供Postman集合。
Journey Orchestration 通过以下步骤设置API访问。每个步骤详见Adobe I/O文档。
要管理Adobe I/O的证书,请确保您对组织具有系统管理员权限,或在管理控制台中具有开发人员帐户权限。
要建立安全的服务到服务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:
要获取您的组织ID值,请咨询您的管理员或Adobe技术联系人。 在许可证列表中创建新集成时,您还可以将其检索到Adobe I/O(请参阅Adobe I/O文档)。
<access_token>:您的个人访问令牌,通过POST请求交换JWT时检索到。
<api_key>:您的个人API密钥。它在Adobe I/O创建到Journey Orchestration服务的新集成后提供。
上限设置API可帮助您创建、配置和监控您的上限设置配置。
方法 | 路径 | 说明 |
---|---|---|
POST | 列表/endpointConfigs | 获取端点封顶配置的列表 |
POST | /endpointConfigs | 创建端点封顶配置 |
POST | /endpointConfigs/{uid} /deploy |
部署端点封顶配置 |
POST | /endpointConfigs/{uid} /undeploy |
取消部署端点上限设置配置 |
POST | /endpointConfigs/{uid} /canDeploy |
检查是否可以部署终结点上限设置配置 |
PUT | /endpointConfigs/{uid} |
更新端点封顶配置 |
GET | /endpointConfigs/{uid} |
检索端点封闭配置 |
DELETE | /endpointConfigs/{uid} |
删除入点上限设置配置 |
创建或更新配置时,将自动执行检查以确保有效负荷的语法和完整性。
如果出现问题,操作会返回警告或错误以帮助您更正配置。
下面是端点配置的基本结构:
{
"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"
潜在错误有:
<!--<given value>-->
:必须为“dataSource”或“action”潜在的警告是:
ERR_ENDPOINTCONFIG_106:上限配置:未定义最大HTTP连接数:默认情况下无限制
在本节中,您将找到在Journey Orchestration中管理上限设置配置时可执行的五个主要用例。
为了帮助您进行测试和配置,此处提供了Postman集合。
此邮递员集合已设置为共享通过Adobe I/O控制台的集成 >试用>下载邮递员变量集合,该集合生成具有选定集成值的邮递员环境文件。
下载并上传到Postman后,您需要添加三个变量:{JO_HOST}
、{Base_Path}
和{SANDBOX_NAME}
。
{JO_HOST}
: Journey Orchestration 网关URL{BASE_PATH}
:入口点。值为“/authoring”{SANDBOX_NAME}
:与执 行API操作的 sandbox名称对应的标题x-sandbox-name(例如,“prod”)。有关详细信息,请参阅沙箱概述。在以下部分中,您将找到Rest API调用的有序列表以执行用例。
用例n°1:创建和部署新的上限配置
用例n°2:更新和部署尚未部署的上限配置
用例n°3:取消部署和删除已部署的上限配置
用例n°4:删除已部署的上限设置配置。
在仅一个API调用中,可以使用forceDelete参数取消部署和删除配置。
用例n°5:更新已部署的上限配置