【API】認定証の付与

  • 更新

Learn365では、 Learn365 APIを通じて、ユーザーに認定証を付与することができます。

ここでは、Learn365 APIを通じて、ユーザーに認定証を付与する方法について説明します。

この方法は、たとえば、受講者が既に完了しているトレーニングに認定証の設定が追加された場合などに有効です。

手順:

1.APIにアクセスし、認証を行います。

https://api.365.systems/  にアクセスし、適切なAPIキーで認証されていることを確認してください。

2.エンドポイントを選択します。

Certificates セクションで以下のエンドポイントを選択し、右上の[Try it out]をクリックします。

POST /odata/v2/Certificates Create a Certificate

Award a certificate via API1.png

3.「Certificate」パラメータを設定します。

「Edit Value」フィールドで、以下を入力します。

  • "Id": "guid":IDは、認定証が付与された後に取得されるため、フィールドから削除します。
  • "CourseId": "guid":「guid」 を認定証に関連するコースのIDに置き換えます。このパラメータは必須です。
  • "ContentUrl": "string":ContentUrl は、認定証が付与された後に、Learn365によって生成されるため、フィールドから削除します。
  • "IsGenerated": "boolean":IsGenerated は、テンプレートから認定証が生成された後に、Learn365 によって値が入力されるため、フィールドから削除します。
  • "Status": "integer":認定証のステータスを設定するには、「integer」を次のいずれかに置き換えます。このパラメータは任意です。
    • 0:有効
    • 1:期限切間近
    • 2:期限切れ
  • "Issued": "2023-07-31T05:32:05Z":認定証の発行日です。既定では、現在の日付と時刻が自動的に入力されています。手動で任意の日時に変更できます。このパラメータは必須です。
  • "Expiry": "2023-07-31T05:32:05Z":認定証の有効期限です。既定では、現在の日付と時刻が自動的に入力されています。手動で任意の日時に変更できます。
  • "TemplateId": "guid":認定証用のPDFファイルを生成する場合、このパラメータは必須です。「guid」を、認定証の生成に使用する認定証テンプレートのIDに置き換えます。 生成しない場合は省略できます。
  • "UserId": "guid":「guid」 を認定証を付与するユーザーのIDに置き換えます。 このパラメータは必須です。
  • "UserLoginName": "string":このパラメータは任意です。「string」をユーザーのログイン名に置き換えます。ユーザーのログイン名は、UserIdの取得時に同じResponse bodyで見つけることができます。

Award a certificate via API2.png

4.[Execute]をクリックしてリクエストを実行します。

5.「Responses」ブロックで結果を確認します。

  • Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
  • Response bodyでは、設定されたパラメータを持った認定証が付与されたことが確認できます。 ”value” パラメータの値は、付与された認定証のユニークなIDです。
    この認定証は、Learn365管理センターでユーザーの受講履歴や進捗で確認することができます。
  • Downloadオプションを使用して、APIリクエストの結果をJSONフォーマットでローカルデバイスに保存できます。

Award a certificate via API3.png