需求

必備知識

必要產品

  • AEM Mobile
  • On-Demand Services API 的存取權

簡介

Adobe Experience Manager Mobile (AEM Mobile) 提供強大的 On-Demand Services API,可讓您以程式設計的方式管理文章、系列、產品、推播通知等項目。此 API 也實現了協力廠商系統整合,例如內容管理系統、網路型編寫工具和發佈工作流程系統,其中的許多工具和系統現在已可使用 (請參閱「整合協力廠商系統與 AEM Mobile」)。

不論您是要撰寫自訂程式碼來與 On-Demand Services API 相互聯繫,還是想要利用與協力廠商系統的其中一項現有整合,您都需要有效的 API 認證。本文將說明如何使用 API 金鑰。

 

API 認證

API 認證是由下列項目組成:

  • 「API 金鑰」與「用戶端密碼」為存取 API 閘道的認證。
  • 「裝置 ID」 和「裝置 Token」 為識別 API 用戶的認證。

API 使用案例和需求

根據您要如何透過 On-Demand Services API 相互聯繫,應該符合以下需求。

代管 (多租用戶) 解決方案

範例:WoodWing Enterprise、WoodWing Inception、Storied 和 Specle。

  • 每個代管解決方案都需要專屬的 API 金鑰。
  • 代管解決方案的用戶不需要專屬的 API 金鑰。
  • 解決方案擁有者會將此 API 金鑰提供給用戶/客戶。
  • 代管解決方案的用戶會使用此 API 金鑰產生其專屬的裝置 ID 和裝置 Token,然後將這些認證輸入代管解決方案中。

內部部署 (單一租用戶) 解決方案

範例:Adobe Experience Manager、vjoon K4、WordPress 和 Drupal。

  • 想要部署內部部署解決方案的每個客戶都需要專屬的 API 金鑰。
  • 客戶可以將其 API 金鑰用於他們實作的多個內部部署解決方案中。
  • 客戶必須產生其專屬的裝置 ID 和裝置 Token,然後將這些認證輸入其內部部署解決方案中。

自訂整合

範例:合作夥伴或客戶編寫的自訂工作流程。

  • 與內部部署 (單一租用戶) 案例的需求相同。
  • 客戶需要其專屬的 API 金鑰、裝置 ID 和裝置 Token。

如需有關如何取得您所需之 API 認證的詳細資訊,請參閱以下章節。

申請 API 金鑰

API 金鑰是用來取得 Adobe API 閘道的存取權。此閘道是一個通用基礎結構,這些 API 也在使用它。所有公開 API 都位在 Adobe API 閘道的背後。您需要 API 金鑰才能夠與 API 閘道背後的服務互動。API 金鑰不會繫結至個別 Adobe ID,而且除非 Adobe 撤銷,否則也不會過期。API 金鑰由兩個部分組成:名稱和機密資訊。您可以將此機密資訊視為 API 金鑰的「密碼」。

API 金鑰和用戶端密碼有時會有其他名稱。以下是同等術語:

API 金鑰 =「IMS 用戶端 ID」=「用戶端 ID」=「Adobe API 金鑰」=「Adobe 金鑰」

用戶端密碼 =「密碼」=「Adobe API 密碼」=「Adobe 密碼」

若要申請 API 金鑰,請下載並送出申請表格 PDF 檔。如需詳細資訊,請參閱「整合協力廠商系統與 AEM Mobile:API 金鑰」。

建議您不要使用主管理員的 Adobe ID 來存取 API。只有在建立專案以及為每個所需專案新增專用帳戶時,才使用主管理員帳戶。舉例來說,如果您有 Drupal 執行個體與 WordPress 執行個體,而且您的主管理員為 aemm_master@adobe.com,您 Drupal 的專用 API 的 Adobe ID 可能是 aemm_drupal@adobe.com (非主管理員)。您 WordPress 的專用 Adobe ID 可能是 aemm_wordpress@adobe.com (非主管理員)。然後您可能會使用 aemm_master@adobe.com 建立名為「Drupal Mag」和「WordPress Mag」的專案,並且將 aemm_drupal@adobe.com 和 aemm_wordpress@adobe.com 新增至這些專案中,並只提供必要的角色與權限。只將您計畫的 API 用途所需的權限授與這些專用 API 帳戶,例如「新增及編輯內容」、「刪除內容」、「檢視內容」和「發佈內容」。請查看您的解決方案的文件,以了解所需的特定權限。請參閱「AEM Mobile 的帳戶管理」。

如果您的申請被獲准,您將會被授與 IMS 用戶端 ID (也就是您的 API 金鑰) 和您的用戶端密碼。您指定的 Adobe ID 將會列在「允許名單」中,這樣您就可以建立關聯的裝置 ID 和裝置 Token,如接下來的步驟所述。

 

 

 

產生裝置 ID 和裝置 Token

一旦您擁有 API 金鑰和用戶端密碼,您必須產生裝置 ID 和裝置 Token,以便識別 API 用戶。

  1. 請瀏覽 IMS 裝置 Token 產生器 (「AEX Portal」),網址為 https://aex.aemmobile.adobe.com/,並輸入您的 API 金鑰/IMS 用戶端 ID。
  2. 使用位於允許名單而且您想要對其建立裝置 ID/Token 的 Adobe ID 登入 (您在 API 金鑰申請表格中指定的其中一個 Adobe ID)。
  3. 隨即產生及顯示裝置 ID 和裝置 Token。將其複製並儲存在安全的地方。

請注意,當 Adobe ID 的密碼變更時,裝置 ID/裝置 Token 將會失效。您可以將裝置 ID/裝置 Token 視為 Adobe ID 和密碼的雜湊。

也請注意一點,裝置 ID/裝置 Token 的有效期間為 6 個月,如果未使用的話將會失效。如果有在使用的話,就會自動續訂。

存取 AEM Mobile API

如果您要透過 API 連接支援的協力廠商系統,只要在系統設定流程中,將 API 金鑰和用戶端密碼 (僅限內部部署/單一租用戶解決方案)、裝置 ID 和裝置 Token 輸入適當的欄位。

如果您要透過自訂程式碼直接存取 API,請依照 On-Demand Services API 套件中的文件指示進行:

  • 裝置 ID/裝置 Token 是用來透過驗證 API 端點產生存取 Token。
  • 所有 API 呼叫都需要 API 金鑰和存取 Token 的組合。

在開發和生產環境使用 API 金鑰

如果您要開發自訂整合功能,或者您擁有不同的生產與開發用內部部署系統,則應該針對開發和生產作業使用不同的 API 金鑰。

當您開發新的系統時,可以使用上述程序申請 API 金鑰。當您開始將系統部署到生產環境時,您需要申請額外的 API 金鑰。

逐步淘汰裝置 ID 和裝置 Token 技術帳戶

未來,裝置 ID 和裝置 Token 工作流程將會由新的技術帳戶實作方式取代,此方式是透過隨選入口網站進行管理。API 金鑰將會維持不變。此系統將會提供可用來申請存取 Token 的「技術帳戶」,而不是使用裝置 ID 和裝置 Token 來進行驗證 (及取得存取 Token)。為了引導此程序的進行,將會產生「一次性 Token」,此識別碼只能使用一次。帳戶資訊的用戶將會透過 Adobe 服務交換一次性 Token 來取得驗證 Token。產生的 Token 可以儲存起來,以供將來驗證使用。

此産品由 Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License 授權  Creative Commons 條款未涵蓋 Twitter™ 與 Facebook 文章。

法律說明   |   線上隱私權政策