Journey Orchestration的API支援5000個事件/秒,但某些外部系統或API不能具有等效的吞吐量。 所以 Journey Orchestration 附帶了一個稱為Capping API的專用功能,用於監控和限制我們施加給外部系統的速率。
在資料源配置期間,您將定義到系統的連接以檢索將用於您的行程的其他資訊,或者為操作定義,您將配置第三方系統的連接以發送消息或API調用。 每次由Journey執行API調用時,查詢封頂API,調用通過API引擎。 如果定義了限制,則呼叫被拒絕,外部系統不會過載。
對於外部資料源,每秒最大調用數設定為15。 如果呼叫數超過每秒15次,則放棄剩餘的呼叫。 您可以增加私有外部資料源的此限制。 聯繫Adobe,將端點包括在允許清單中。 對於公共外部資料源,這是不可能的。 要瞭解有關整合外部系統時的最佳做法和保證的更多資訊,請參閱此 頁。
要瞭解有關操作或資料源配置的詳細資訊,請參見 關於操作 或 關於資料源
的 Journey Orchestration 在可用的Swagger檔案中描述了封蓋API 這裡。
將此API與 Journey Orchestration 實例,您需要使用AdobeI/O控制台。 您可以按照此操作 Adobe開發人員控制台入門 然後使用此頁中的部分。
要test和準備您的整合,可提供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 | list/endpointConfigs | 獲取端點封頂配置清單 |
POST | /endpointConfigs | 建立端點封頂配置 |
POST | /endpointConfigs/{uid} /deploy |
部署終結點封頂配置 |
POST | /endpointConfigs/{uid} /取消部署 |
取消部署終結點封頂配置 |
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>"
}
當 可部署 方法被調用,進程驗證配置並返回由其唯一ID標識的驗證狀態:
"ok" or "error"
潛在錯誤有:
<!--<given value>-->
:必須是「dataSource」或「action」潛在警告是:
ERR_ENDPOINTCONFIG_106:上限配置:未定義最大HTTP連接數:預設情況下不限制
在本節中,您將發現可以執行的五個主要用例,以管理中的封蓋配置 Journey Orchestration。
為幫助您進行測試和配置,提供了Postman收藏 這裡。
此Postman集合已設定為共用通過 Adobe I/O控制台的整合 >試用>下載Postman,生成具有選定整合值的Postman環境檔案。
下載並上傳到Postman後,需要添加三個變數: {JO_HOST}
。{Base_Path}
和 {SANDBOX_NAME}
。
{JO_HOST}
: Journey Orchestration 網關URL{BASE_PATH}
:API的入口點。 值為「/authoring」{SANDBOX_NAME}
:標題 x-sandbox-name (例如,「prod」),與API操作將在其中進行的沙盒名稱相對應。 查看 箱概述 的子菜單。在以下部分中,您將找到Rest API調用排序清單以執行用例。
用例n°1: 建立和部署新的封頂配置
用例n°2: 更新和部署尚未部署的上限配置
用例n°3: 取消部署和刪除已部署的封頂配置
用例n°4: 刪除已部署的封頂配置。
在僅一個API調用中,可以使用forceDelete參數取消部署和刪除配置。
用例n°5: 更新已部署的封頂配置