検索

【API】認定証の再発行

  • 更新

すでにコースやトレーニングプランで発行された認定証の再発行や更新をすることができます。

たとえば発行済みの認定証に使用された認定証テンプレートが更新された（背景画像や、テキストが変更された）場合に、それを適用し、必要な場合再発行できます。

また、発行済みの認定証に、別のテンプレートを適用し、再発行することも可能です。

発行済みの有効な認定証（有効、期限切間近）の「有効期限」は、PATCH /odata/v2/Certificates({Id}) で変更できます。詳しくは、「【API】認定証の更新」をご参照ください。

ここでは、発行済みの認定証に対する認定証テンプレートの更新と、認定証の再発行について説明します。

 

事前準備

発行済み認定証の更新または再発行を行うには、以下の情報が必要です。

認定証の更新、再発行に同じ認定証テンプレートを使用する場合は、そのテンプレートのIDを取得する必要があります。テンプレートIDは、発行済み認定証のIDを取得した際、レスポンスの ”TemplateId” パラメータの横に表示されます。

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

 

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

手順：

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

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

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

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

GET /odata/v2/CertificatesTemplates Returns the list of Certificate Templates

3．必要に応じて、クエリーオプション パラメータを入力ます。

例：

  • $filter フィールドに「CertificateType eq 'Course'」と入力します。これにより、レスポンスにコース用の認定証テンプレートのみを返します。
  • 認定証テンプレートの名前が分かっている場合は、$filterフィールドに「Title eq 'certificate template title'」と入力します（'certificate template title' は認定証テンプレートの名前に置き換えます）。これにより、そのテンプレートのIDを直接取得できます。

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

4．［Execute］をクリックしてリクエストを実行します。

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

  • Code 2xx（例：200）は、リクエストが正しく動作したことを示します。
  • Response bodyには、テナントのすべての認定証テンプレートの情報が表示されます。認定証テンプレートIDは、”Id” の横に表示されています。
  • Ctrl+Fを使って目的のテンプレートを検索できます。
  • Downloadオプションを使用して、APIリクエストの結果を JSONフォーマットでローカルデバイスに保存できます。

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

  • クエリ オプション パラメータが設定された場合、レスポンスには設定された条件に一致する認定証テンプレートの情報のみが表示されます。

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

 

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

手順：

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

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

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

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

POST  /odata/v2/Certificates({Id})/Reissue  Reissue Certificate

3．「Id＊」フィールドに、更新または再発行を行う認定証IDを入力します。

4．「Edit Value」フィールドに、次のパラメータを入力します。

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

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

4．［Execute］をクリックしてリクエストを実行します。

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

  • Code 2xx（204など）は、リクエストが正しく動作したことを示します。

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

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

例：背景画像とテキストが更新された認定証の再発行

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