API利用マニュアル(v4)
サイト内で利用しているデータを整形して開発者向けに提供しています。
このページはタブレットまたはPCのような横幅の広い画面で閲覧することを推奨します。
v3と大きく変わりませんが、レスポンスの項目が増えていますので、対応をよろしくお願いします。
共通仕様
GETで取得します。
結果は一部を除いてJSON形式で返します。文字コードはUTF-8です。
パラメータ名末尾に「[]」がつくリクエストはコンマ区切りで値の複数指定が可能です。
パラメータ名末尾に「[]」がつくレスポンスは配列で返ります。(結果が1つの場合でも配列になります。)
値が空のときにNULLを返す項目と空文字列を返す項目があります。必要に応じて変換をお願いします。
保管されているデータをあまり変換せず出力しているため不思議な仕様になっていますが、ご了承ください。
URI
ベースのURIは「https://api.fujiwarahaji.me/v4/」です。
HTTPSでの通信を推奨していますが、HTTPでの通信も可能です。
接続元を見ていませんのでHTTPで通信時もHTTPSのURIを返します。
HTTP利用時のセキュリティ対策は開発者さまのほうでよろしくお願いします。
/list 一覧・検索
| 必須 | パラメータ | 内容 | 値 | 初期 |
|---|---|---|---|---|
| 必須 | type | 出力モードを楽曲に設定 | music | |
| 任意 | limit | 出力する上限数 | 自然数 | 無限 |
| 任意 | music_type[] | 楽曲の種類で絞り込み | cg ml sc as joint cover remix sidem gakuen 876 | 全種 |
| 任意 | orderby | 出力順序 | title date rand | date |
| 任意 | order | 出力の正順・逆順 | asc desc | desc |
| 任意 | search | キーワード検索 | 検索キーワード |
https://api.fujiwarahaji.me/v4/list?type=music&search=器&limit=1 「器」を含む楽曲を1曲表示する
| パラメータ親 | パラメータ子 | 説明 | 出力値 |
|---|---|---|---|
| name | 曲名 | ||
| type | music | ||
| music_type | 楽曲のタイプ | cg ml sc as joint cover remix sidem gakuen 876 | |
| song_id | 楽曲ID(内部管理ID) | 数値 | |
| link | 楽曲ページURL | ||
| api | 曲情報のJSON URI |
| 必須 | パラメータ | 内容 | 値 | 初期 |
|---|---|---|---|---|
| 必須 | type | 一覧表示する分類 | live idol lyrics composer arrange disc cv | |
| 任意 | orderby | 出力順序(type=live以外で有効。liveは日付順固定。カバーライブは最後にまとまります。) | name count | name |
| 任意 | order | 出力の正順・逆順 | asc desc | desc |
| 任意 | search | キーワード検索 | 検索キーワード 分類名とyyyy-mm-dd形式以外の検索はできません。 |
title |
| 任意 | production[] | アイドルの所属プロダクション(type=idolでのみ有効。) | cg 765 sc 315 gakuen va-liv | 全プロダクション |
https://api.fujiwarahaji.me/v4/list?type=idol&production=765 765プロ所属のアイドル一覧を表示
| パラメータ親 | パラメータ子 | 説明 | 出力値 |
|---|---|---|---|
| name | 曲名 | ||
| type | 出力しているカテゴリ名 | live idol lyrics composer arrange disc cv | |
| tax_id | カテゴリID(内部管理ID) | 数値 | |
| link | ふじわらはじめ内カテゴリページURL | ||
| api | カテゴリのJSON URI | ||
| date | ライブの日時(type=liveの場合のみ) | yyyy-mm-dd | |
| production | アイドルの所属プロダクション(type=idolの場合のみ) | cg 765 sc 315 gakuen va-liv | |
| kana | アイドル名よみがな(type=idolの場合のみ) | ||
| cv | 声優名(type=idolの場合のみ) | ||
| cvkana | 声優名よみがな(type=idolの場合のみ) |
/tax カテゴリ内一覧・カテゴリ情報
アイドル名、ユニット名の部分一致での検索、その他のカテゴリでの検索が必要な場合はまず/listより検索を実行してAPIを実行してください。
ユニット名は表記ゆれなどがある場合がありますので、「unit_name」で完全一致を狙うのはあまりおすすめできません。
ライブの日付も同様にスラッグの完全一致が必要です。同じ日にライブが複数回ある場合などデータが引き出せない場合があります。
| 必須 | パラメータ | 内容 | 値 | 初期 |
|---|---|---|---|---|
| いずれか1つが必須 id→idol_name→unit_name→live_dateの優先順で排他利用 |
id | tax_id | 自然数 | |
| idol_name | アイドル名(完全一致) | 名字と名前の間にスペースなし(例:藤原肇) | ||
| unit_name | ユニット名(完全一致) | |||
| live_date | ライブの日付 | 同じ日に複数回ライブがあるなど重複がない限り「yyyy-mm-dd」 スラッグ(ライブページURLの「https://fujiwarahaji.me/live/」以降の部分)を利用 |
||
| 任意 | limit | 出力する上限数 | 自然数 | 無限 |
| 任意 | music_type[] | 楽曲の種類で絞り込み | cg ml sc as joint cover remix sidem gakuen 876 | 全種 |
| 任意 | orderby | 出力順序 | name date random | name |
| 任意 | order | 出力の正順・逆順 | asc desc | desc |
| 任意 | member_plain | メンバー情報をプレーンテキストで出力 | TRUE(1などでも可) | FALSE |
https://api.fujiwarahaji.me/v4/tax?idol_name=春日未来&music_type=joint,cg アイドル名「春日未来」の参加する合同楽曲、シンデレラ曲を取得
| パラメータ親 | パラメータ子 | 説明 | 出力されるカテゴリ | 出力値 |
|---|---|---|---|---|
| name | カテゴリ名(アイドル名、ライブ名) | all | ||
| type | 出力しているカテゴリ名 | |||
| tax_id | カテゴリID(内部管理ID) | 数値 | ||
| link | ふじわらはじめ内カテゴリページURL | |||
| api | カテゴリのJSON URI | |||
| kana | よみがな ユニットは難読ユニットを中心に一部のみ対応。 |
idol unit | ||
| cv | 声優名 | idol | ||
| cvkana | 声優名よみがな | idol | ||
| production | アイドルの所属プロダクション | idol | cg 765 sc 315 gakuen va-liv | |
| date | ライブの日時 | live | yyyy-mm-dd | |
| place | ライブ会場 | live | ||
| cat | 分類ワード(シリーズをまとめるためのキーワード) | disc live | ||
| flag[] | ジャンルフラグに使用予定(現時点では未使用) | disc live | ||
| member[] | 参加メンバー、ユニットメンバー | live unit | member型 | |
| setlist | セットリストのかたちで出力されるかどうか discまたはliveでセットリスト・収録曲リストの形になっている場合TRUEになります。 FALSEの場合、出力順はセットリスト順・CDのトラック順になっていません。 |
live disc | TRUE or FALSE | |
| lyrics composer arrange |
同じ名義で作業した楽曲一覧を表示するためのカテゴリ情報を出力します。 | |||
| tax_id | 同じ名義のカテゴリID(内部管理ID) | lyrics composer arrange | 数値 | |
| link | 同じ名義のふじわらはじめ内カテゴリページURL | lyrics composer arrange | ||
| api | 同じ名義のカテゴリのJSON URI | lyrics composer arrange | ||
| music[] | 楽曲情報の出力場所です。 | |||
| name | 曲名 | all | ||
| type | music | |||
| music_type | 楽曲のタイプ | cg ml sc as joint cover remix sidem gakuen 876 | ||
| song_id | 楽曲ID(内部管理ID) | 数値 | ||
| link | 楽曲ページURL | |||
| api | 曲情報のJSON URI | |||
| song_text | セットリスト補足情報、MCなど | disc live | ||
| unit[] | 参加ユニット | disc live | unit型 | |
| member[] | 参加メンバー | member型solo(discかつsetlist=TRUEの場合) member型(liveまたはdiscかつsetlist=TRUEの場合) |
||
| member_text | メンバー情報補足情報(ユニット名など) | disc(setlist=TRUEの場合のみ) live | ||
| flag[] | ディスク収録に関するフラグ(off vocalやgame verなど) | disc(setlist=TRUEの場合のみ) | ||
| solo | ソロ音源が収録されたCDがあるか | disc(setlist=FALSEの場合のみ) | TRUE or FALSE | |
/music 楽曲情報
HTTPヘッダーの「last-modified」にデータ最終更新日を出力します。
ただし、内部処理でカテゴリーに紐付いているデータ(ライブの会場・日付・歌唱メンバー、アイドルのCV情報など)の更新時間は反映されません。
| 必須 | パラメータ | 内容 | 値 | 初期 |
|---|---|---|---|---|
| 必須 | id | データを表示する楽曲ID | 自然数 |
| パラメータ親 | パラメータ子 | 説明 | 出力値 |
|---|---|---|---|
| name | 曲名 | ||
| type | 出力している情報の種類 | music | |
| song_id | 楽曲ID(内部管理ID) | ||
| link | ふじわらはじめ内楽曲URL | ||
| api | 楽曲のJSON URI | ||
| remix[] original[] |
リミックスの場合:「remix[]」として原曲の情報を出力 楽曲の場合:「original[]」としてリミックスバージョンの一覧を出力 |
||
| name | 曲名 | ||
| type | music | ||
| song_id | 楽曲ID(内部管理ID) | ||
| link | 楽曲ページURL | ||
| api | 曲情報のJSON URI | ||
| lyrics[] composer[] arrange[] | 作詞・作曲・編曲(リアレンジ楽曲などのアレンジ者含む)情報 ただし、リミックスでは作詞・作曲情報は出力されません(項目自体が消えます) |
||
| name | 名前 | ||
| type | 出力しているカテゴリ名 | lyrics composer arrange | |
| tax_id | カテゴリID(内部管理ID) | ||
| link | ふじわらはじめ内カテゴリページURL | ||
| api | カテゴリのJSON URI | ||
| lyrics_url | 歌詞サイトURL (リミックスでは出力されません。必要な場合は原曲から参照してください。フロントエンドでの機能を廃止したため現在データ更新を行っていません。) |
URL | |
| member[] | CD、配信、ゲーム(CGSS,MLTD)参加メンバー | member型 | |
| digital | デジタル配信の有無 | TRUE or FALSE | |
| disc[] | CD情報 | ||
| name | ディスク名 | ||
| type | 出力しているカテゴリ名 | disc | |
| tax_id | カテゴリID(内部管理ID) | ||
| link | ふじわらはじめ内カテゴリページURL | ||
| api | カテゴリのJSON URI | ||
| live[] | 披露されたライブの情報 | ||
| name | ライブ名 | ||
| type | 出力しているカテゴリ名 | live | |
| tax_id | カテゴリID(内部管理ID) | ||
| link | ふじわらはじめ内カテゴリページURL | ||
| api | カテゴリのJSON URI | ||
| date | ライブの日時 | yyyy-mm-dd | |
| place | ライブ会場 | ||
/movie 楽曲の動画表示
| 必須 | パラメータ | 内容 | 値 | 初期 |
|---|---|---|---|---|
| 必須 | id | データを表示する楽曲ID | 自然数 | |
| 任意 | plain | TRUEに指定すると元データをそのまま出力 利用方法はレスポンス欄で |
TRUE or FALSE |
https://api.fujiwarahaji.me/v4/movie?id=4436&plain=1 ID「4436」の楽曲をプレーンテキストで表示
「plain=FALSE」の場合、HTTP形式で出力されます。
「plain=TRUE」の場合、WordPressでショートコード実行される前のプレーンテキストが出力されます。
WordPressのARVE(Advanced Responsive Video Embedder)プラグインのショートコードを通過させるか各自でデータの処理が必要です。
エラーメッセージを出力しないかわりにHTTPステータスコードで状態の確認ができます。
- 200:正常出力されています。
- 204:楽曲IDの指定は正常ですが、動画情報がない楽曲です。
- 400:パラメーターに不正があります。
レスポンス型
よく使うunit型、member型のレスポンスのかたちは以下の通りです。| パラメータ | 説明 | 出力値 |
|---|---|---|
| name | ユニット名 | |
| type | 出力しているカテゴリ名 | unit |
| tax_id | カテゴリID(内部管理ID) | 数値 |
| link | ふじわらはじめ内カテゴリページURL | |
| api | カテゴリのJSON URI | |
| member[] | ユニットメンバー | member型 |
| パラメータ | 説明 | 出力値 |
|---|---|---|
| name | アイドル名 | |
| type | 出力しているカテゴリ名 | idol |
| tax_id | カテゴリID(内部管理ID) | 数値 |
| link | ふじわらはじめ内カテゴリページURL | |
| api | カテゴリのJSON URI | |
| production | アイドルの所属プロダクション(type=idolでのみ有効) | cg 765 sc 315 gakuen va-liv |
| cv | 声優名 | |
| solo | ソロバージョンかどうか(member型soloの場合のみ) | TRUE or FALSE |
この場合、すべての情報のレスポンスが「member」にまとまります。(テキスト内がユニットかメンバーかそれ以外かを判定する処理をバイパスするため)
そのぶん処理が高速になりますので状況に応じてご利用ください。
出力されるテキストは半角コンマ区切りとなります。ユニット名やアイドル名では半角コンマを使わないよう運用しています。
- orig
便宜上楽曲のオリメンにあたるトラック。フロントエンドでは表示していない裏データです。複数のYouTube Musicから代表的なものを1つピックアップするのに使うフラグとして利用しています。 - offvocal
オフボーカル音源(メンバー情報は原則空です。) - gamever
ゲームバージョン、Shortバージョンなどフル音源ではないもの。
v3からの主な変更点
- アイドルのプロダクションを現行のものに変更しました。(315 gakuen va-livを追加しました。)
- 学マス、SideM、876の楽曲のデータが出力できるようになりました。(sidem gakuen 876の追加を行いました。)
- disc、liveで内部のソートやジャンル分けに使用予定のcat、flagを出力するようになりました。
データベースにデータを追加するまでは空データを返します。
更新情報
2023/11/29 v4正式配信、ドキュメント公開
2025/10/13 v4試験配信
Twitter「#ふじわらはじめAPI」 でも更新情報・メンテナンス情報などをお知らせしています。
なにかありましたらTwitter・メールフォーム・マシュマロなどから連絡ください。
PAGE TOP