アプリケーションデベロッパーマニュアル

Adobe Learning Manager は、クラウドホスト環境で学習者中心のセルフサービス学習を実現できる管理ソリューションです。Learning Manager API を使用すると、プログラムで Learning Manager リソースにアクセスして、他のエンタープライズアプリケーションと統合させることができます。アドビパートナーは、API を使用して機能を拡張したり、他のアプリケーションやサービスと統合したりすることで、Learning Manager の価値提案を高めることもできます。

使用シナリオ

デベロッパーは Learning Manager API を使用して、Learning Manager の機能を拡張した自己完結型アプリケーションを構築したり、Learning Manager を他のエンタープライズアプリケーションワークフローと統合したりできます。お好みのテクノロジーを使用して、Web アプリケーション、デスクトップクライアント、モバイルアプリを開発することもできます。 デベロッパーは、Learning Manager からアプリケーションデータにアクセスできます。開発するアプリケーションが、Learning Manager プラットフォームの外部でデプロイされるため、アプリケーションの発展に合わせてソフトウェア開発ライフサイクルをきめ細かく制御できます。通常、Learning Manager アカウントで使用するアプリケーションは、顧客組織により開発されます。それらのアプリケーションは非公開で、その特定の顧客組織にのみ対応します。Learning Manager API を使用すると、アドビパートナーが、大勢の Learning Manager のお客様にご利用いただける汎用アプリケーションを構築することも可能です。

Learning Manager API

Learning Manager API は、REST の原則に基づいており、Learning Manager オブジェクトモデルの主要な要素をアプリケーションデベロッパーに HTTP で公開します。デベロッパーは、API エンドポイントと HTTP メソッドの詳細を知らなくても、さまざまな Learning Manager オブジェクト、その属性および相互関係について理解できます。モデルを理解できたら、API リクエストと API 応答の構造に関する基本を学び、API 全体でよく使用される一般的なプログラミング用語を覚えることは有益です。

さまざまな API エンドポイントとメソッドについての詳細は、Learning Manager API ドキュメントを参照してください。

API 認証

Prime に API 呼び出しを行うアプリケーションを作成する場合は、統合管理アプリを使用してアプリケーションを登録する必要があります。 

Learning Manager API では、OAuth 2.0 フレームワークを使用して、クライアントアプリケーションを認証および承認します。 

手順

1. アプリケーションの設定

適切なエンドポイントを使用するように、クライアント ID とクライアントシークレットを使用してアプリケーションを設定できます。 アプリケーションが登録されると、clientId と clientSecret を取得できます。 Get URL は、SSO やアドビ ID などの事前設定されたアカウントを使用して、ブラウザーで Learning Manager ユーザーを認証する際に使用されます。 

GET https://captivateprime.adobe.com/oauth/o/authorize?client_id=<Enter your clientId>&redirect_uri=<Enter a url to redirect to>&state=<Any String data>&scope=<one or more comma separated scopes>&response_type=CODE

認証が成功すると、ブラウザーは上記の URL に示された redirect_uri にリダイレクトします。 パラメーターコードがリダイレクト URI と共に表示されます。

2. コードを使用した更新トークンの取得

POST https://captivateprime.adobe.com/oauth/token Content-Type: application/x-www-form-urlencoded

POST リクエストの本文：

3.更新トークンからアクセストークンを取得

アクセストークンを取得する URL： 

POST https://learningmanager.adobe.com/oauth/token/refresh Content-Type: application/x-www-form-urlencoded

POST リクエストの本文：

アクセストークンの詳細情報の確認用 URL

GET https://learningmanager.adobe.com/oauth/token/check?access_token=<access_token>

アクセストークンの詳細情報の確認用 URL

ヘッドレス LMS アプリケーションは、初回ログイン時に refresh_token を保持します。 その後、refresh_token を使用してクライアントアプリケーションに access_token を生成し、API を呼び出します。 同様に、コンテンツ再生では OAuth エンドポイントが使用され、再生ファイルを管理するための Cookie が生成されます。この Cookie には、複数のコンテンツファイルと、これらのファイルによって Cookie を使用して呼び出される API 呼び出しが含まれます。 OAuth によって生成される Cookie の有効期限は、access_token と同じく 7 日間です。 Cookie が生成されると、一般的な Web アプリケーションのログアウトとは異なるため、生成された Cookie を消去できません。 OAuth Cookie と Web アプリケーション Cookie は別々の Cookie であるため、相互に認識できません。

Cookie をクリアするために、新しいエンドポイントを導入しました。このエンドポイントにより、refresh_token、Cookie、および Cookie と refresh_token の両方を呼び出せます。

詳細

使用制限

アクセストークンは 7 日間有効です。 その後は、更新トークンを使用して新しいアクセストークンを生成する必要があります。 既存のアクセストークンが有効な場合に、更新トークンから新しいアクセストークンを生成すると、既存のトークンは返却されます。 

Learning Manager API でよく使用される用語の一部が、参考のために以下に説明されています。 

Includes

デベロッパーは、単一の API オブジェクトモデルと、そのモデルに関連付けられた複数のモデルにアクセスできます。 後続の関連するモデルにアクセスするには、各モデルと他のモデルとの関係性を理解する必要があります。 デベロッパーは Includes パラメーターを使用して、依存モデルにアクセスできます。 カンマ区切りを使用すると、複数のモデルにアクセスできます。 使用例と Includes の詳細については、このページのサンプル API モデルのセクションを参照してください。 

API リクエスト

API リクエストは、HTTP リクエストで実行できます。 エンドポイントやメソッドに応じて、デベロッパーは、GET、PUT、POST、DELETE、PATCH など、さまざまな HTTP 動詞を選択する場合があります。 リクエストの中には、クエリパラメーターを渡すことができるものもあります。 ユーザーは、特定のデータモデルをリクエストする場合に、JSON API 仕様に従って、関連するモデルをリクエストすることもできます。 一般的な API リクエストの構造は、サンプルモデルの使用例で説明されています。

API 応答

クライアントにより API リクエストが実行されると、JSON API 仕様に従って SON ドキュメントの取得が行われます。 この応答には、デベロッパーがアプリケーションロジックで次の手順を適切に実行する際に照合できる、HTTP ステータスコードも含まれます。 一般的な API 応答の構造は、サンプルモデルの使用例 で説明されています。

エラー

API リクエストに失敗すると、エラー応答を取得します。 応答で返される HTTP ステータスコードに、エラーの性質が示されています。 エラーコードは、API リファレンス内の各モデルの番号を使って表示されます。 HTTP アクセスに問題がある場合に API で表される一般的なエラーには、200、204、400、404 などがあります。  

フィールド

API オブジェクトの属性や関係は、総称としてフィールドと呼ばれます。 詳しくは、JSON API を参照してください。API 呼び出しを行う際に、フィールドをパラメーターとして使用して、1 つ以上の特定の属性をモデルから取得できます。 フィールドパラメーターがない場合、API 呼び出しは、モデルから使用可能な属性をすべて取得します。 例えば、次の API 呼び出しの場合、fields[skill]=name により、スキルモデルの名前属性のみを取得します。 

https://captivateprime.adobe.com/primeapi/v2/users/{userId}/userSkills/{id}?include=skillLevel.skill&fields[skill]=name 

ページネーション

API リクエストにより、応答でオブジェクトの長いリストが返ってくる場合があります。 このような場合、デベロッパーはページネーション属性を使用して、結果を順番に取得できます。記録の範囲を各ページに示した複数のページが単位となります。 例えば、Learning Manager のページネーションの属性により、1 ページに表示する記録の最大数を設定できます。また、ページに表示される記録の範囲値を定義することもできます。 

並べ替え

API モデルでは並べ替えが可能です。 モデルに基づいて、結果に適用する並べ替えの種類を選択します。 並べ替えには、昇順または降順を適用できます。 例えば、sort=name と指定した場合、名前は昇順に並びます。 sort=-name と指定した場合には、名前が降順に並びます。 詳しくは、JSON API 仕様を参照してください。 

API の使用例

デベロッパーが、スキル名、スキルレベルに割り当てられた最大ポイント、そのスキルについて学習者が獲得したポイントなどを取得するというシナリオについて考えます。

Learning Manager API の userSkill モデルは、デフォルトの属性として id、type、dateActived、dateCreated、pointsEarned で構成されています。したがって、デベロッパーが GET メソッドを使用して userSkill モデルの詳細を取得すると、デフォルト属性に付随する現在のデータが応答出力に表示されます。 

ただし、このシナリオでは、デベロッパーはユーザーのスキル名と、スキルレベルに対するポイントを取得するものとします。 Learning Manager API により、関係フィールドを使用して関連情報にアクセスし、パラメーターを含めることが可能です。userSkill に関連付けられたモデルは、関連タグで取得できます。 これらのモデルを userSkill と一緒に呼び出して、関連付けられた各モデルの詳細を取得できます。 この情報を取得するには、関連するモデルごとにドット（ピリオド）で区切られた値を持つ、include パラメーターを使用します。 user include=skillLevel.skill,course などのように、カンマを区切り文字として使用して別のモデルをリクエストすることもできます。

API 呼び出し

https://captivateprime.adobe.com/primeapi/v2/users/{userId}/userSkills/{id}?include=skillLevel.skill&fields[skill]=name&fields[skillLevel]=maxCredits&fields[userSkill]=pointsEarned

例として、userId は 746783、userSkill ID は 746783_4426_1 とします。 

API 呼び出しの応答

Learning Manager モデル

Learning Manager API を使用すると、開発者は Learning Manager オブジェクトに RESTful リソースとしてアクセスできます。 各 API エンドポイントは、通常、バッジなどのオブジェクトインスタンスといったリソースを指しており、そのようなオブジェクトのコレクションを指すこともあります。 デベロッパーは、PUT、GET、POST、DELETE などの HTTP 動詞を使用して、それらのオブジェクト（コレクション）に対する CRUD 操作を実行します。

アプリケーション開発プロセス

前提条件

デベロッパーは、Prime で体験版アカウントを作成して、そのアカウント内すべての役割にフルアクセス権を持つ必要があります。 アプリケーションの作成にあたって、デベロッパーはユーザーやコースを作成して、アカウントを適切な状態にする必要があります。そのようにして、開発中のアプリケーションがサンプルデータにアクセスできるようにします。

クライアント ID とシークレットの作成

アプリケーション開発とテスト

Learning Manager API は、デベロッパーがさまざまなアプリケーションを構築する際に使用できます。デベロッパーは、アカウントが有効なユーザーとコースで構成されていることを確認する必要があります。 複数のダミーユーザーやコースを作成して、体験版アカウントでアクティビティをシミュレートして、アプリケーションの機能をテストできます。

アプリケーションデプロイメント

実用アカウントでは、Learning Manager の管理者や統合管理者が、組織内のユーザーにアプリケーションを使用する権限を与えるようにすることをお勧めします。アプリケーションのテストが完了して、実用の準備が整ったら、実用アカウントの管理者に通知します。 管理者が、実用アカウントでアプリケーションの新しいクライアント ID とクライアントシークレットを生成し、それらを安全に組み込めるよう、アプリケーション内で必要な手順を取るのが理想的です。 アプリケーションをデプロイする実際の手順は、企業によって異なります。デプロイを完了するには、組織の Learning Manager 管理者が、組織内の IT/IS 部門からサポートを受ける必要があります。

外部アプリケーションの承認

外部アプリケーションを追加するには、アプリケーションページの右上隅にある「承認」をクリックします。 外部アプリケーション ID を入力し、「保存」をクリックします。

よくある質問

1. Learning Manager は e コマースと統合されていますか？

Adobe Learning Manager に e コマース統合機能はありません。ただし、独自のヘッドレス LMS を作成し、e コマース機能を実装できるように、API を提供しています。