API利用マニュアル（v3）
サイト内で利用しているデータを整形して開発者向けに提供しています。
v2までのバージョンと大きく異なる部分がありますので、注意の上ご利用ください。
共通仕様
GETで取得します。
結果は一部を除いてJSON形式で返します。文字コードはUTF-8です。
パラメータ名末尾に「[]」がつくリクエストはコンマ区切りで値の複数指定が可能です。
パラメータ名末尾に「[]」がつくレスポンスは配列で返ります。（結果が1つの場合でも配列になります。）
値が空のときにNULLを返す項目と空文字列を返す項目があります。必要に応じて変換をお願いします。
保管されているデータをあまり変換せず出力しているため不思議な仕様になっていますが、ご了承ください。
URI
ベースのURIは「https://api.fujiwarahaji.me/v3/」です。
HTTPSでの通信を推奨していますが、HTTPでの通信も可能です。
HTTPで通信時もHTTPSのURIを返します。
HTTP利用時のセキュリティ対策は開発者さまのほうでよろしくお願いします。
/list 一覧・検索
曲一覧
リクエスト
| 必須 | パラメータ | 内容 | 値 | 初期 |
|---|---|---|---|---|
| 必須 | type | 出力モードを楽曲に設定 | music | |
| 任意 | limit | 出力する上限数 | 自然数 | 無限 |
| 任意 | music_type[] | 楽曲の種類で絞り込み | cg ml sc as joint cover remix sidem | 全種 |
| 任意 | orderby | 出力順序 | title date rand | date |
| 任意 | order | 出力の正順・逆順 | asc desc | desc |
| 任意 | search | キーワード検索 | 検索キーワード |
https://api.fujiwarahaji.me/v3/list?type=music&search=器&limit=1 「器」を含む楽曲を1曲表示する
レスポンス
配列で出力されます。
| パラメータ親 | パラメータ子 | 説明 | 出力値 |
|---|---|---|---|
| name | 曲名 | ||
| type | music | ||
| music_type | 楽曲のタイプ | cg ml sc as joint cover remix sidem | |
| 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 | 全プロダクション |
https://api.fujiwarahaji.me/v3/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 | |
| 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 | 全種 |
| 任意 | orderby | 出力順序 | name date random | name |
| 任意 | order | 出力の正順・逆順 | asc desc | desc |
| 任意 | member_plain | メンバー情報をプレーンテキストで出力 | TRUE（1などでも可） | FALSE |
https://api.fujiwarahaji.me/v3/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 | |
| date | ライブの日時 | live | yyyy-mm-dd | |
| place | ライブ会場 | live | ||
| member[] | 参加メンバー、ユニットメンバー | live unit | member型 | |
| setlist | セットリストのかたちで出力されるかどうか discまたはliveでセットリスト・収録曲リストの形になっている場合TRUEになります。 |
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 | ||
| 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/v3/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型のレスポンスのかたちは以下の通りです。unit型
| パラメータ | 説明 | 出力値 |
|---|---|---|
| name | ユニット名 | |
| type | 出力しているカテゴリ名 | unit |
| tax_id | カテゴリID（内部管理ID） | 数値 |
| link | ふじわらはじめ内カテゴリページURL | |
| api | カテゴリのJSON URI | |
| member[] | ユニットメンバー | member型 |
member型
| パラメータ | 説明 | 出力値 |
|---|---|---|
| name | アイドル名 | |
| type | 出力しているカテゴリ名 | idol |
| tax_id | カテゴリID（内部管理ID） | 数値 |
| link | ふじわらはじめ内カテゴリページURL | |
| api | カテゴリのJSON URI | |
| production | アイドルの所属プロダクション（type=idolでのみ有効） | cg 765 sc 315 |
| cv | 声優名 | |
| solo | ソロバージョンかどうか（member型soloの場合のみ） | TRUE or FALSE |
メンバー情報のプレーン出力
クエリパラメータで「member_plain=1」や「member_plain=TRUE」などを付加すると、メンバー情報・ユニット情報をまとめてプレーンテキストで出力します。
この場合、すべての情報のレスポンスが「member」にまとまります。（テキスト内がユニットかメンバーかそれ以外かを判定する処理をバイパスするため）
そのぶん処理が高速になりますので状況に応じてご利用ください。
出力されるテキストは半角コンマ区切りとなります。ユニット名やアイドル名では半角コンマを使わないよう運用しています。
この場合、すべての情報のレスポンスが「member」にまとまります。（テキスト内がユニットかメンバーかそれ以外かを判定する処理をバイパスするため）
そのぶん処理が高速になりますので状況に応じてご利用ください。
出力されるテキストは半角コンマ区切りとなります。ユニット名やアイドル名では半角コンマを使わないよう運用しています。
v2.1からの主な変更点
- 楽曲のサブスク情報（YouTube Music）の出力に対応しました。
- サブスク対応の際に導入したセットリスト型のディスク収録情報の出力に対応しました。
- 保守しやすくするため、楽曲情報（/music）でのセットリスト・ディスクメンバー情報の出力を取りやめました。
出力されていた情報は個別のライブセットリスト、ディスク収録情報から引き出せます。 - ユニット・メンバー情報のプレーンテキストでの出力に対応しました
- /movie 楽曲動画の出力ができるようになりました。
更新情報
2023/06/22 22時頃、ライブセットリストのメンバー情報を「全員」にしている時、データの処理がうまくいかずnullになる現象を確認し修正しました。
2023/06/18 v3提供開始
Twitter「#ふじわらはじめAPI」 でも更新情報・メンテナンス情報などをお知らせしています。
なにかありましたらTwitter・メールフォーム・マシュマロなどから連絡ください。
以下、リリース前に掲載していたお知らせです。
レスポンス見本の公開を行います
ドキュメントはありませんが、レスポンスの見本として開発中のバージョンを公開します。 なお、このレスポンスの内容については予告なく変更を行う場合があります。 更新などの都合で出力されるデータの変更、ダウンする時間等が発生する可能性がありますので、本番環境には適用しないようにお願いします。 取得したデータの利用についてはライセンス通りの利用をいただいて大丈夫です。 公開場所：https://api.fujiwarahaji.me/beta/ 以下 リクエスト項目についてはv2.1と同じものが使えます。
メジャーバージョンアップ（v3）についてのお知らせ
サブスク対応をはじめとしたシステムの変更に追従するアップデートになる予定です。 また、今後のメンテナンスのことなどを考えたシステム改修を行います。 このバージョンアップで出力される情報のうち複数の場所で引き出せる情報を一部削除します。 具体的には楽曲情報（/music）のCDメンバー、ライブメンバーなどを削除する予定でいます。 カテゴリ情報（/tax）のほうが詳細で実態にあった情報（同一楽曲が同じCDで複数トラック収録される場合など）を提供できますのでこちらに一本化します。 取得する場所が異なるだけで今までと同じ情報が取得できます。 もともと複雑なフローを複数場所に出力していましたので、これからの保守を考えてこうなりました…。 そしてサブスク情報ですが、ライブセットリストとほぼ同じ形式でレスポンスを返すようになる予定です。 流用がしやすくなっていると思いますので、こちらに移行をよろしくお願いします。 フルバージョンがサブスク配信されている曲に関してはYouTube Musicでの楽曲ID（例：QE7gsIGnyqw）も配信予定です。 その他変更点がありましたらまたお伝えします。 v2も更新は行いませんが提供を続けますのでそちらもご活用ください。PAGE TOP