Learn365 API での API キーによる認証方法

  • 更新

Learn365 API を使用するには、ユーザーは適切な API キーを使用して認証する必要があります。

ここでは、API キーの取得する方法と、Swagger または Postman を使用した Learn365 API の認証方法について説明します。

 

Learn365 API キーの取得 

この操作に必要なロール:LMS 管理者 または Microsoft 365 グローバル管理者

Learn365 では、複数の API キーを生成できます。権限レベルは「読み取り専用」と「フル コントロール」の 2 種類があります。

手順:

1.Learn365 管理センター「すべてのカタログ」> 管理 > API キー管理 に移動します。

2.対象の API キー を選択し、[API キーのコピー] オプションを使用してコピーします。

authorize with an API key-1.png

 

適切な API キーを取得した後は、それを使用して Learn365 API へのアクセスを認証できます。

 

Swagger で Learn365 API を認証する

手順:

1.https://api.365.systems/  にアクセスし、画面を下にスクロールして「Learn365 Cloud API」に移動します。

2.[Authorize]ボタン、または使用する API エンドポイントのロック アイコンを選択します。「Available authorizations」ポップアップウインドウが開きます。

authorize with an API key-2.png

3.Basic authorization の項目に以下を入力します。 

  • Username:api
  • Password:あらかじめコピーしておいた Learn365 API キーを貼り付けます。 

4.認証を行うには[Authorize」 を選択します。操作を中止する場合は[Close]を選択します。

authorize with an API key-3.png

 

認証後、Learn365 API からログアウトするには

手順:

1.[Authorize]ボタン、または 対象の API エンドポイントのロック アイコンを選択します。「Available authorizations」ポップアップウインドウが開きます。

2.[Logout]ボタンを選択します。

authorize with an API key-4.png

 

Postman で認証する

手順:

1.「Authorization」タブに移動します。

2.「タイプ」ドロップダウンメニューから、「Basic Auth」タイプを選択します。

3.Username と Password フィールドに入力します。

  • Username:api
  • Password:あらかじめコピーしておいた Learn365 API キーを貼り付けます。 

4.[Send]を選択します。

認証情報は自動的にリクエスト内に含まれ、リクエストが送信されるたびに使用されます。

authorize with an API key-5.png