AccessReading開発者ページへようこそ!
(最終更新日: 2019-01-09)
APIリファレンスへようこそ
AccessReading Web API(以下Web API)はWeb版のAccessReading(以下Web版)が持つ機能をベースにWebサービスとして実装したAPI群です。
Web APIはREST Webサービスとして実装されています。Web APIで取得できる処理結果はいずれもHTTPのStatusもしくはJSON,XML形式のデータです。
また、Web APIの操作にはBasic認証による認証が必要です。認証に用いるID, PasswordはWeb版で利用しているログインID, Passwordと同じ物が利用できます。
Web APIでは認証で指定されたログインIDに紐づくRoleやアクセス権限(書籍のダウンロード許可)の範囲でAPIを実行することができます。
※Roleやアクセス権限についての詳細は、AccessReading事務局にお問い合わせください。
(最終更新日:2019.01.09)
機能概要
AccessReadingトップページにある書籍一覧相当の情報を取得します。
URI
https://books.accessreading.org/api/search/books
リクエストメソッド
GET
フォーマット
json, xml
パラメータ
パラメータ名 |
指定方法 |
備考 |
書籍タイトル |
title={書籍タイトル} |
書籍名に含まれる文字列を指定します。 |
著者 |
Author={著者} |
著者名に含まれる文字列を指定します。 |
カテゴリーID(教科書・一般書籍) |
CategoryId={カテゴリーID} |
カテゴリーIDは、カテゴリー一覧取得APIより取得できます。 |
出版社 |
Publisher={出版社} |
出版社名に含まれる文字列を指定します。 |
学年ID |
GradeId={学年ID} |
学年IDは、学年一覧取得APIより取得できます。 |
書籍ID |
BookId={書籍ID} |
書籍IDは、本APIの検索結果より取得できます。 |
ページ番号 |
Page={ページ番号} |
Web APIでは1度に取得できるデータ件数は1,000件を上限としています。1,000件以降のデータ取得を行う場合は、1ページを1,000件として、ページ指定を行うことによって取得することができます。
■2ページ目(1,001~2,000件目)のデータ取得を指定する例
https://books.accessreading.org/api/search/books?Page=2
|
ダウンロード可能書籍のみ |
downloadable={ダウンロード可能書籍のみ} |
他の検索オプションで取得した書籍情報検索結果より、ダウンロード許可が与えられている書籍を抽出する検索オプションを指定します。
パラメータ:1 = 権限設定が行われている書籍のみ, 0 = 特に絞り込みを行わない |
書籍種別 |
fileformat={書籍種別} |
他の検索オプションにより取得した書籍情報検索結果より、特定の書籍種別の書籍ファイルを保持する書籍を抽出する検索オプションを指定します。
パラメータ: 1 = docx, 2 = epub, 0 = 特に絞り込みを行わない |
戻り値
フィールド |
型 |
説明 |
BookId |
数値 |
書籍IDは書籍登録時に付与される整数値です。(マイナス数値は存在しません) |
Publisher |
文字列 |
出版社名を返します。 |
Title |
文字列 |
書籍のタイトルを返します。 |
Subject |
文字列 |
教科名を返します。 |
GradeId |
数値 |
学年のIDを返します。どのIDがどの学年かは、学年一覧取得APIより取得できます。 |
PassYear |
数値 |
教科書における検定年を和暦で表した際の数値部分を返します。 |
PassYearNengo |
文字列 |
教科書における検定年を和暦で表した際の元号をアルファベット1字で略したものを返します。 |
HasBookFiles |
真偽 |
ログインユーザがダウンロードできるファイルが存在する場合"true"、存在しない場合"false"を返します。 |
検索条件の指定について
- 検索条件の指定方法は「あいまい検索」「ID」「ページ番号」の3種類があり、検索項目単位で設定方法が異なります。
これらの検索条件は同時に指定が可能です。ただし、同一の検索項目は複数指定できません。
- あいまい検索で指定する項目
- 書籍タイトル(title)
- 著者(Author)
- 出版社(Publisher)
※あいまい検索では検索キーワードをUTF-8で指定します。検索キーワードは「+」で区切ることにより複数指定することが可能です。(AND検索となります。)
- IDで指定する項目
- カテゴリーID(CategoryId)
- 学年ID(GradeId)
- 書籍ID(BookId)
- 検索条件が未指定の場合、認証で指定されたログインIDに紐づくRoleやアクセス制限に基づき、検索ができる書籍一覧全件を取得します。
- 検索条件の指定はURLの「?」以降(つまりクエリ文字列)に「検索項目名=検索キー」の形式で指定します。
例)https://books.accessreading.org/api/search/books?title=いっすんぼうし
- 複数の検索項目を同時に指定したい場合、検索項目の間を「&」で結ぶことによって複数条件の指定が可能です。
例)
https://books.accessreading.org/api/search/books?title=いっすんぼうし&Page=2
https://books.accessreading.org/api/search/books?title=うらしま&publisher=○○出版
- ただし、一度の検索API実行に対して同じ項目は2度指定できません。
NG例)
https://books.accessreading.org/api/search/books?title=うらしま&title=ももたろう&publisher=○○出版
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
- 404 NotFound 対象となる書籍データは存在しません。
機能概要
AccessReadingでの「書籍情報」相当の情報を取得できます。
URI
https://books.accessreading.org/api/bookdetail/{bookId}
リクエストメソッド
GET
フォーマット
json, xml
パラメータ
戻り値
フィールド |
型 |
説明 |
Title |
文字列 |
書籍のタイトルを返します。 |
Publisher |
文字列 |
出版社名を返します。 |
Authors |
文字列 |
著作者を返します。 |
GradeId |
数値 |
学年のIDを返します。どのIDがどの学年かは、学年一覧取得APIより取得できます。
一般書籍など学年を指定しない場合は「指定しない = 99」という値。 |
SubjectId |
数値 |
教科書における教科IDを返します。 |
Mark |
文字列 |
教科書における記号を返します。 |
PassYear |
数値 |
教科書における検定年を和暦で表した際の数値部分を返します。 |
PassYearNengo |
文字列 |
教科書における検定年を和暦で表した際の元号をアルファベット1字で略したものを返します。 |
Notes |
文字列 |
内容注記返します。 |
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
- 404 NotFound 対象となる書籍データは存在しません。
機能概要
AccessReadingにおける「書籍ファイル一覧」相当の情報を取得できます。
URI
https://books.accessreading.org/api/bookfiles/{bookId}
リクエストメソッド
GET
フォーマット
json, xml
パラメータ
戻り値
フィールド |
型 |
説明 |
BookFileId |
数値 |
書籍ファイルのIDを返します。 |
Title |
文字列 |
書籍のタイトルを返します。 |
FileFormat |
文字列 |
"DOCX"または"ePub"を返します。 |
RubiExists |
真偽 |
ルビ付きか否かを返します。 |
ImageExists |
真偽 |
挿絵付きか否かを返します。 |
FileQuality |
数値 |
書籍品質を返します。 |
Status |
数値 |
ダウンロードステータスを返します。
- 1 = ダウンロード要求可(未申請)
- 2 = ダウンロード準備中(ファイル作成中)
- 3 = ダウンロード可能
- 4 = ダウンロード再要求可(ファイル更新あり)
- 5 = ダウンロード要求失敗
|
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
- 403 Forbidden 対象ファイルにアクセスする権限がありません。
- 404 NotFound パラメータの指定に誤りがあります。
機能概要
検索で指定できる「カテゴリー一覧」(一般書籍・教科書)の情報を取得できます。
URI
https://books.accessreading.org/api/categories/
リクエストメソッド
GET
フォーマット
json, xml
パラメータ
パラメータ名 |
指定方法 |
備考 |
書籍ファイルID |
{bookFileId} |
書籍IDは、書籍情報検索結果取得APIの検索結果より取得できます。 |
戻り値
フィールド |
型 |
説明 |
CategoryId |
数値 |
カテゴリーIDを返します。 |
CategoryName |
文字列 |
カテゴリーの名前を返します。 |
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
機能概要
検索で指定できる「学年一覧」の情報を取得できます。
URI
https://books.accessreading.org/api/grades/
リクエストメソッド
GET
フォーマット
json, xml
パラメータ
なし
戻り値
フィールド |
型 |
説明 |
GradeId |
数値 |
学年のIDを返します。 |
GradeName |
文字列 |
学年の名前を返します。 |
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
機能概要
AccessReadingにおける「書籍ファイルリクエスト」と同等の機能です。
指定された書籍ファイルのダウンロード可能となるようリクエストします。
ただし、リクエストできるファイルは管理者によって許可されたファイルのみです。
URI
https://books.accessreading.org/api/book/{bookFileId}
リクエストメソッド
PUT
フォーマット
-
パラメータ
パラメータ名 |
指定方法 |
備考 |
書籍ファイルID |
{bookFileId} |
書籍ファイルIDは、書籍ファイル一覧取得APIの検索結果より取得できます。 |
戻り値
-
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
- 403 Forbidden 指定されたファイルへのアクセスは承認されていません。
- 404 NotFound ファイルは処理中、または存在しません。
機能概要
ダウンロード可能となったファイルの取得を行います。
対象ファイルのリクエストが行われていない場合やサムプリント埋込処理により処理中の場合は「401 – Unauthorized」もしくは「404 – FileNotFound」のステータスが返されます。
URI
https://books.accessreading.org/api/book/{bookFileId}
リクエストメソッド
GET
フォーマット
-
パラメータ
パラメータ名 |
指定方法 |
備考 |
書籍ファイルID |
{bookFileId} |
書籍ファイルIDは、書籍ファイル一覧取得APIの検索結果より取得できます。 |
戻り値
指定したファイル
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
- 403 Forbidden 指定されたファイルへのアクセスは承認されていません。
- 404 NotFound ファイルは処理中、または存在しません。
機能概要
Web APIにアクセスしたユーザーのユーザー種別の取得を行います。
URI
https://books.accessreading.org/api/user/
リクエストメソッド
GET
フォーマット
json, xml
パラメータ
なし
戻り値
フィールド |
型 |
説明 |
UserType |
数値 |
1 = 一般の利用者 2 = 学校関係者 3 = 管理者 |
エラー時のステータスコード
- 401 Unauthorized ユーザー名またはパスワードの指定に誤りがあります。
AccessReadingが公開しているソフトウェアのご紹介
Bookshelf for AccessReading
クリックすると大きくなります
このソフトウェアは、AccessReadingをご利用の方が、AccessReadingが提供する音声教材をダウンロードしたり、ダウンロードした音声教材を利用しやすいように管理するためのものです。
※ AccessReadingにお申し込みでない方は、まずはお申し込みをおねがいいたします。(AccessReadingのページはこちら)
※ 開発者向けに、ソースコードを添付しています。
ダウンロード
インストール手順や開発者向けの情報は、以下の「Readme」の中に記載しております。
Readme
概要
これは、AccessReadingの利用者が以下のことをできるようにするソフトウェアです。
- ダウンロード可能な書籍一覧の取得
- 書籍のダウンロード
- 書籍を開く
詳細
AccessReading Web APIを利用しています。
- 書籍情報検索結果取得API
- 書籍ファイル一覧取得API
を使ってファイル一覧を得て、
- 書籍ファイルリクエストAPI
- 書籍ファイル取得API
でファイルをダウンロードしています。
インストール
Windowsの場合
- Node.jsをインストールする
- このソフトをダウンロードして解凍し、このファイル(readme.md.txt)を含むフォルダをカレントディレクトリとして、コマンドプロンプトを起動
-
- 32bitの場合: npm run build -- win32
- 64bitの場合: npm run build -- win64
- {このファイル(readme.md.txt)を含むフォルダ}\build\bookshelves4accessreading\win{32or64}\ に実行ファイルができる
- 使う予定がない場合、Node.jsはアンインストールして構いません。
macOS (64bit) の場合
- Node.jsをインストールする
- このソフトをダウンロードして解凍し、このファイル(readme.md.txt)を含むフォルダをカレントディレクトリとして、ターミナルを起動
- npm run build -- osx64
- {このファイル(readme.md.txt)を含むフォルダ}/build/bookshelves4accessreading/osx64/ に実行ファイルができる
- 使う予定がない場合、Node.jsはアンインストールして構いません。
開発履歴
2016-10-21 Fri ver. 0.0.6-beta
APIの更新に対応
2016-02-29 Mon ver. 0.0.5-beta
公開
ライセンス
Copyright (c) 2016 SHIMIZU, Manabu AccessReading.org
MIT ライセンス(日本語訳)の下で本ソフトウェアを公開します。
ライセンスの内容を要約すると、以下のようになります。
Wikipedia日本語版 MIT Licenseより引用
- このソフトウェアを誰でも無償で無制限に扱って良い。ただし、著作権表示および本許諾表示をソフトウェアのすべての複製または重要な部分に記載しなければならない。
- 作者または著作権者は、ソフトウェアに関してなんら責任を負わない。
開発のために利用したソフトウェア
Node.js is released under the MIT license, and bundles other liberally licensed OSS components.
Authors License
The MIT License (MIT)
Authors License
The MIT License (MIT)
Copyright (c) 2014 Steffen Müller License
Copyright (c) 2013-2015 by Andrea Giammarchi - @WebReflection
License
The MIT License (MIT)
Copyright (c) 2014 Sam Herbert License