onsen-api-docs はインターネットラジオステーション<音泉>の API の非公式なドキュメントです。
サードパーティで使うことを想定した API ではないため、実際にリクエストを送ることは、推奨しません。 リクエストを送る場合は、自己責任でお願いします。
主にアプリから利用されることを想定した API です。
https://app.onsen.ag
一部のエンドポイントでは、トークンが必要です。
その場合は、事前にトークンを取得するエンドポイントで取得したトークンを、Authorization
ヘッダに指定して、リクエストします。
概要 | メソッド | パス | 認証 |
---|---|---|---|
認可コードを取得する | GET |
/oauth/authorize |
|
トークンを取得する | POST |
/oauth/token |
|
番組一覧を取得する | GET |
/api/programs |
|
番組詳細を取得する | GET |
/api/programs/:directory_name |
|
アカウント詳細を取得する | GET |
/api/me |
✔️ |
このエンドポイントにアクセスして、サインインすることで、認可コードを取得することができます。
種類 | 名称 | 内容 | 必須 |
---|---|---|---|
クエリ | client_id |
b3d68e56145a5d085f6b0ecc6e1ad4a83345ff4ce97d3e16ace95208ad2f1d2f |
✔️ |
クエリ | redirect_uri |
ag.onsen.app://oauth2callback |
✔️ |
クエリ | response_type |
code |
✔️ |
クエリ | scope |
private |
✔️ |
GET https://app.onsen.ag/oauth/authorize?client_id=b3d68e56145a5d085f6b0ecc6e1ad4a83345ff4ce97d3e16ace95208ad2f1d2f&redirect_uri=ag.onsen.app://oauth2callback&response_type=code&scope=private
上記 URL にアクセスして、自身のアカウントでサインインする。 ag.onsen.app://oauth2callback?code=
のような URL にリダイレクトされるため、?code=
のあとの文字列(認可コード)を取得する。
アクセストークンを取得することができます。
種類 | 名称 | 内容 | 必須 |
---|---|---|---|
ヘッダ | Content-Type |
application/x-www-form-urlencoded |
✔️ |
本文 | client_id |
b3d68e56145a5d085f6b0ecc6e1ad4a83345ff4ce97d3e16ace95208ad2f1d2f |
✔️ |
本文 | client_secret |
291ba633343212ad706abbb4dae8cda6aa96ae53ed6597298121e63db491a089 |
✔️ |
本文 | grant_type |
authorization_code |
✔️ |
本文 | code |
private |
✔️ |
本文 | redirect_uri |
ag.onsen.app://oauth2callback |
✔️ |
POST https://app.onsen.ag/oauth/token
主に公式サイトから利用されることを想定した API です。
https://www.onsen.ag
一部のエンドポイントでは、トークンが必要です。
その場合は、事前にサインインするエンドポイントへのリクエストで取得した Cookie を使用して、リクエストします。
概要 | メソッド | パス | 認証 |
---|---|---|---|
サインインする | POST |
/web_api/signin |
|
イベント記事一覧を取得する | GET |
/web_api/event_articles |
|
オススメ記事一覧を取得する | GET |
/web_api/recommended_articles |
|
広告一覧を取得する | GET |
/web_api/commercials |
|
バナー一覧を取得する | GET |
/web_api/ads/default |
|
変更履歴一覧を取得する | GET |
/web_api/change_logs |
|
番組一覧を取得する | GET |
/web_api/programs |
|
番組詳細を取得する | GET |
/web_api/programs/:directory_name |
|
オススメ番組一覧を取得する | GET |
/web_api/programs/recommended |
|
番組別声優一覧を取得する | GET |
/web_api/programs/performers |
|
番組を検索する | GET |
/web_api/programs/search |
|
声優を検索する | GET |
/web_api/programs/search_performer |
|
アニラジアワード 音泉ノミネート番組一覧を取得する | GET |
/web_api/rankings |
|
アカウント詳細を取得する | GET |
/web_api/me |
✔️ |