必要条件

前提知識

  • AEM Mobile について理解していること
  • オンデマンドポータルでのコンテンツの作成および公開に関する知識があること
  • On-Demand Services API の使用経験があること

必要な製品

  • AEM Mobile
  • On-Demand Services API へのアクセス

はじめに

Adobe Experience Manager Mobile(AEM Mobile)により提供されるパワフルな On-Demand Services API を使用して、記事、コレクション、製品、プッシュ通知などをプログラムによって管理できます。また、API により、サードパーティ製品をコンテンツ管理システム、Web ベースのオーサリングツール、パブリッシングワークフローシステム、また現在入手可能な多くのツールと連携させることができます。(詳しくは、サードパーティ製システムと AEM Mobile の連携を参照してください)。

On-Demand Services API と相互にやり取りするカスタムコードを記述する場合であっても、サードパーティ製システムとの既存の連携を利用する場合であっても、有効な API 証明書が必要になります。この記事では API キーの使用方法を説明します。

 

API 証明書

API 証明書は、次のアイテムで構成されます。

  • API キークライアントシークレット。API Gateway にアクセスするための証明書です。
  • デバイス IDデバイストークン。API ユーザーを識別するための証明書です。

API 使用シナリオと要件

On-Demand Services API を使用してどのようにやり取りするかによって、以下の要件が適用されます。

ホステッド(マルチテナント)ソリューション

例:WoodWing Enterprise、WoodWing Inception、Storied、Specle

  • すべてのホステッドソリューションには、独自の API キーが必要です。
  • ホステッドソリューションのユーザーは、独自の API キーを必要としません。
  • ソリューション所有者が、この API キーをユーザーやお客様に提供します。
  • ホステッドソリューションのユーザーはこの API キーを使って独自のデバイス ID とデバイストークンを生成し、これらの資格情報をホステッドソリューションに入力します。

オンプレミス(シングルテナント)ソリューション

例:Adobe Experience Manager、vjoon K4、WordPress、Drupal

  • オンプレミスのソリューションを展開するすべてのお客様に、独自の API キーが必要です。
  • お客様は、実装する複数のオンプレミスソリューション全体にこの API キーを使用できます。
  • お客様は、独自のデバイス ID とデバイストークンを生成し、これらの資格情報を自身のオンプレミスソリューションに入力する必要があります。

カスタム統合

例:パートナーまたはお客様がコード化したカスタムワークフロー

  • オンプレミス(シングルテナント)の場合と同じ要件が適用されます。
  • お客様には、独自の API キー、デバイス ID、デバイストークンが必要です。

必要な API 証明書の取得について詳しくは、次のセクションを参照してください。

API キーのリクエスト

API キーは、Adobe API Gateway へのアクセス権を取得するために使用します。このゲートウェイは共通インフラストラクチャで、API によっても使用されます。すべてのパブリック API は、Adobe API Gateway の背後にあります。API ゲートウェイの背後にあるサービスとやり取りするには、API キーが必要です。API キーは、個々の Adobe ID には結び付けられず、アドビが無効にするまで期限が切れることはありません。API キーは、名前とシークレットで構成されます。シークレットは、API キーの「パスワード」と考えることができます。

API キーとクライアントシークレットは他の名前で呼ばれることがあります。これらを以下に示します。

API キー = 「IMS クライアント ID」 = 「クライアント ID」 = 「Adobe API キー」 = 「Adobe キー」

クライアントシークレット = 「シークレット」 = 「Adobe API シークレット」 = 「Adobe シークレット」

API キーをリクエストするには、リクエストフォームの PDF をダウンロードして送信します。詳しくは、サードパーティ製システムと AEM Mobile の連携:API キーを参照してください。

API アクセスにマスター管理者 Adobe ID を使用しないことをお勧めします。マスター管理者アカウントを使用するのは、プロジェクトを作成し、専用のアカウントを必要な各プロジェクトに追加する場合のみです。例えば、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 やデバイストークンを作成できます。

 

 

 

デバイス ID とデバイストークンの生成

API キーとクライアントシークレットを取得したら、API ユーザーの識別に使用するデバイス ID とデバイストークンを生成する必要があります。

  1. IMS Device Token Generator(「AEX Portal」)(https://aex.aemmobile.adobe.com/)にアクセスし、API キー/IMS クライアント ID を入力します。
  2. デバイス ID/トークンの作成に必要なホワイトリストされた Adobe ID(API キーリクエストフォームで指定したいずれかの Adobe ID)を使ってログインします。
  3. デバイス ID とデバイストークンが生成され、表示されます。これらをコピーして、安全な場所に格納します。

デバイス ID とデバイストークンは、Adobe ID パスワードを変更すると無効になります。デバイス ID とデバイストークンは、Adobe ID とパスワードのハッシュと考えることができます。

また、デバイス ID とデバイストークンは 6 か月間有効で、使用しないと無効になります。使用した場合、自動更新されます。

AEM Mobile API へのアクセス

API を使用してサポートされているサードパーティ製システムに接続するには、単に API キーとクライアントシークレット(オンプレミスのソリューションまたはシングルテナントソリューションの場合のみ)、デバイス ID、デバイストークンをシステムの設定プロセスの適切なフィールドに入力します。

自身のカスタムコードから直接 API にアクセスする場合は、On-Demand Services API パッケージ内のドキュメントの指示に従います。

  • デバイス ID およびデバイストークンは、認証 API エンドポイント経由でアクセストークンを生成するのに使用します。
  • すべての API 呼び出しに、API キーとアクセストークンの組み合わせが必要です。

開発および制作環境における API キーの使用

カスタム統合を開発する場合、または、制作または開発に個別のオンプレミスシステムがある場合、開発と制作に別々の API キーを使用する必要があります。

新しいシステムを開発する場合、上に記載した手順に従って API キーをリクエストできます。システムの制作への導入を開始したら、追加の API キーをリクエストする必要があります。

デバイス ID およびデバイストークンのテクニカルアカウントへの段階的移行

今後、デバイス ID とデバイストークンのワークフローは、オンデマンドポータルで管理される新しいテクニカルアカウント実装に置き換えられる予定です。API キーはそのまま使用されます。認証(およびアクセストークンの取得)にデバイス ID やデバイストークンを使用するのではなく、システムにより「テクニカルアカウント」が提供され、これを使ってアクセストークンをリクエストできます。プロセスをブートストラップするために、「1 回だけのトークン」が生成されます。この識別子を使用できるのは 1 回のみです。アカウント情報のコンシューマーが、アドビのサービスを通じて 1 回だけのトークンを認証トークンに交換します。この認証トークンは、将来の認証に備えて格納できます。

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー