APIで認定証再発行、設定を更新する

  • 更新

LMS365 では、コース/トレーニングプランの設定で認定証の有効期限が変更された場合、すでに付与された有効な認定証(有効および期限切れ)にも反映されますが、認定証のプロパティの変更は反映されません。

例えば、認定証テンプレートの背景画像やテキスト内容が変更された場合、これらの変更をすでに付与された認定証に反映するには、LMS365 APIを使用します。

LMS365 APIを使用すると、すでに付与された認定証のプロパティを更新し再発行することができます。

ここでは、その方法についてご説明します。

前提条件

API で認定証の更新して再発行するには、以下の情報が必要です。

認定証のプロパティの更新や再発行に、現在と同じ認定証テンプレートを使用する場合は、このテンプレートの ID を取得します。
認定証テンプレートIDは、認定証 IDを取得するレスポンスの ”TemplateId” パラメータの横に表示されます。

コース ID を取得する方法で、認定証テンプレートの ID を取得することもできます。
この場合、コースに認定証が設定されている場合、レスポンスの ”CertificateTemplateId” パラメータの隣にテンプレートのIDが表示されます。コースに認定証が設定されていない場合、このパラメータには ”NULL” が表示されます。

認定証テンプレートのIDを取得する

認定証のプロパティの更新や再発行に、現在とは別の認定証テンプレートを使用する場合は、認定証テンプレートストレージから、テンプレートのIDを取得します。

1.https://api.365.systems/ にアクセスし、APIキーで認証します。

2.CertificateTemplates セクションを展開し、GET /odata/v2/CertificatesTemplates Returns the list of Certificate Templates を選択し、開いた画面で右上の「Try it out」を選択します。

3.クエリーオプションパラメータを入力して、レスポンスに返すデータをフィルタリングすることができます。

$filter フィールドに「CertificateType eq 'Course'」と入力して、コース用の認定証テンプレートのみをレスポンスに返します。

$filterフィールドに「Title eq 'certificate title'」と入力('certificate title' は認定証の名前に置き換えます)して、該当する名前の認定証テンプレートをレスポンスに返します。

Reissue a certificate or partially update its properties via API1.png

4.準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。

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

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、クエリオプションパラメータでフィルタリングが設定されていない場合、テナントのすべての認定証テンプレートの情報が表示されます。
  • Ctrl+F を使用して目的の認定証テンプレートを検索できます。”Id” の横に表示されている認定証テンプレートの ID をコピーします。
  • Downloadオプションを使用すると、APIリクエストの結果を JSON 形式でローカルデバイスに保存できます。

Reissue a certificate or partially update its properties via API2.png

クエリオプションパラメータでフィルタリングが設定された場合、レスポンスには、設定された条件を満たす認定証テンプレートの情報のみが表示されます。
”Id” の横に表示されている認定証テンプレートの ID をコピーします。

Reissue a certificate or partially update its properties via API3.png

認定証の再発行とプロパティの更新

認定証のプロパティ(テンプレートの背景やテンプレート自体の画像など)を更新したり、再発行することができます。

トレーニングに設定された有効期限が変更された場合、すでに付与された認定証(有効および期限切れ)の、有効期限も変更されます。

プロパティの更新と再発行は、以下の手順で行います。

1.Certificates セクションを展開し、POST  /odata/v2/Certificates({Id})/Reissue  Reissue Certificate を選択し、開いた画面で右上の「Try it out」を選択します。

2.パラメータを設定します。

  • key:Id:このパラメータは必須です。プロパティの更新、再発行を行う認定証のID を入力します。

  • "templateId": "string":"string" を、認定証に使用する認定証テンプレートのIDに置き換えます。

3.「Execute 」ボタンを選択してリクエストを実行します。

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

  • Codeの下にある2XX(例:204)という数字は、リクエストが正しく動作したことを示します。
  • Response headersで、リクエストの結果を見ることができます。

Reissue a certificate or partially update its properties via API4.png

LMS365管理センター> ユーザーページで、「認定証のダウンロード」でユーザーの認定証をダウンロードするか、「受講の進捗を閲覧」で該当するコース/トレーニングプランの認定証の表示 表示アイコン.svg アイコンを選択して、認定証の PDFファイルをダウンロードし、ファイルを開いて結果を確認します。

例:背景画像とテキストを更新した認定証

Reissue a certificate or partially update its properties via API5.png