概要
API接続を用いることで、ライセンス情報をシステム的に自動で取得することができます。
2022年12月26日（月）に正式公開しました。
ライセンスAPIを利用するためには、APIキーが必要です。
APIキーの取得方法については利用申請をご参照ください。
なお、ライセンス（JUSTICE）は、大学図書館コンソーシアム連合（JUSTICE）会員館限定のサービスです。JUSTICE会員館以外の方で、機能開発等のためにテストを希望される方は、利用申請よりテスト環境へ申請ください。
API仕様 ライセンス一覧取得
有効なライセンスの一覧を取得するためには、Get Licensesコマンドを利用します。
基本書式は以下の通りです。
https://api-ap.hosted.exlibrisgroup.com/almaws/v1/acq/licenses/
この書式の末尾にクエリパラメータを追加できます。
主なクエリパラメータは以下の通りです。
|
パラメータ |
必須orオプション |
説明 |
|---|---|---|
| apikey | 必須 | APIキーを設定してください。 |
|
q |
オプション、初期値: all |
ライセンス名、コード、ライセンサーを条件に検索できます。 |
|
status |
オプション、初期値: all |
ライセンスのステータスを指定します。 現在有効なライセンスを検索対象にするためには”ACTIVE”を指定してください。 |
|
limit |
オプション、初期値: 10 |
検索結果に表示されるライセンスの上限件数です。 指定しない場合は10になり、最大100まで指定できます。 |
|
create_date_from |
オプション |
ライセンスの作成日を検索条件にします。指定した日より後に作成されたライセンスが検索対象になります。 書式 YYYY-MM-DD |
|
create_date_to |
オプション |
ライセンスの作成日を検索条件にします。指定した日より前に作成されたライセンスが検索対象になります。 書式 YYYY-MM-DD |
|
modify_date_from |
オプション |
ライセンスの更新日を検索条件にします。指定した日より後に更新されたライセンスが検索対象になります。 書式 YYYY-MM-DD |
|
modify_date_to |
オプション |
ライセンスの更新日を検索条件にします。指定した日より前に作成されたライセンスが検索対象になります。 書式 YYYY-MM-DD |
クエリサンプル
https://api-ap.hosted.exlibrisgroup.com/almaws/v1/acq/licenses/?apikey=XXXXXXXX&status=ACTIVE
※XXXXXXXXにはAPIキーを設定します。
実行結果
APIの実行結果はXML形式で返戻されます。
主な項目は以下の通りです。
|
license |
|
|
|
|
Code |
ライセンスコード。個別のライセンスを取得するためのキーになります。 |
|
|
name |
ライセンス名称 |
|
|
licensor |
ライセンスを発行しているベンダー名称とベンダーコード。 要素の値にベンダーコード、desc属性の値にベンダー名称が記述されます。 |
|
|
start_date |
ライセンス対象となる期間の開始日 |
|
|
end_date |
ライセンス対象となる期間の終了日 |
|
|
creation_date |
ライセンスが作成された日 |
|
|
modification_date |
ライセンスが更新された日 |
- 実行結果の表示例
全てのクエリパラメータおよび返戻結果の詳細については以下のURLを参照してください。
ExLibris DEVELOPER NETWORK
https://developers.exlibrisgroup.com/alma/apis/docs/acq/R0VUIC9hbG1hd3MvdjEvYWNxL2xpY2Vuc2VzLw==/
API仕様 個別ライセンスの取得
各ライセンスを取得するためにはGet Licenseコマンドを利用します。
基本書式は以下の通りです。
末尾のライセンスコードは、Get Licensesコマンドで取得したものを利用します。
https://api-ap.hosted.exlibrisgroup.com/almaws/v1/acq/licenses/{license_code}
この書式の末尾にクエリパラメータを追加できます。
主なクエリパラメータは以下の通りです。
|
パラメータ |
必須orオプション |
説明 |
|---|---|---|
| apikey | 必須 | APIキーを設定してください。 |
|
lang |
オプション |
ライセンス項目ラベルの言語を指定します。 通常"ja"を指定してください。 |
クエリサンプル
https://api-ap.hosted.exlibrisgroup.com/almaws/v1/acq/licenses/AAA_パッケージAAA_2023?apikey=XXXXXXXX&lang=ja
※XXXXXXXXにはAPIキーを設定します。
実行結果
code, name等の要素はGet Licensesの返戻結果と同様です。
terms要素以下に利用規約を表示します。
|
terms |
|
|
|
|
|
term |
|
|
|
|
|
code |
desc属性の値にライセンス項目のラベル、要素の値にライセンス項目のコードを定義します。 ライセンス項目のコードは一意になっています。 |
|
|
|
value |
要素の値としてライセンス項目の内容を表示します。 |
ライセンス項目の一覧については以下のファイルをご参照ください。
- 全てのライセンス項目には、会員館の利用者への公開可否を定義する「公開可否」項目が付属しています。
公開可否が「公開」のライセンス項目のみ、会員館の利用者への公開が可能です。
「非公開」項目を利用者に公開しないよう十分にお気を付けください。 - 「Description」は、ライセンスに更新があった場合等に更新情報を記入する項目です。値がない場合は、出力されません。
- その他の項目は、値がない場合は「N/A」を出力します。
全てのクエリパラメータおよび返戻結果の詳細については以下のURLを参照してください。
ExLibris DEVELOPER NETWORK
https://developers.exlibrisgroup.com/alma/apis/docs/acq/R0VUIC9hbG1hd3MvdjEvYWNxL2xpY2Vuc2VzL3tsaWNlbnNlX2NvZGV9/
制限事項
APIの利用回数には上限があり、上限回数は全てのAPIテスト環境利用者で共有しています。
利用申請
ライセンスAPIの利用にはAPIキーの申請が必要です。
「APIによる参照」サービスは、以下2種類の環境へお申し込み可能です。
- 本番環境
ライセンス（JUSTICE）のデータを提供する環境です。
JUSTICE会員館のみ申請可能です。 - テスト環境
本番環境と同じ機能を提供する環境です。データはダミーデータとなります。
JUSTICE会員館以外（図書館システムベンダーを含む）も申請可能です。
APIキーは、各申請館のサービス提供に限定して慎重にお取り扱いください。
下記API利用申請フォームからお申し込みください。
お問い合わせ先
ご質問や導入のご相談は、下記お問い合わせフォームからご連絡ください。