melocy API リファレンス

melocy(メロシー) - 演奏ネットワーキングシステムの機能を利用するためのAPIです。

ご質問やAPI拡張のご希望などIがありましたら、support@melocy.comまでお知らせください。

データ形式

戻り値の形式にはJSONかXMLがあります。
リクエスト時、HTTPヘッダの「Accept」に application/jsonを指定するとJSONが、application/xmlを指定するとXMLが返ります。
基本的にJSONでのご利用をおすすめします。

アプリケーション登録

一部APIのご利用には、アプリケーション登録が必要です。
こちらからアプリケーションを登録してお使いください。
http://melocy.com/ma/app/

曲の投稿について

ミックスとはmelocy上で管理される曲の単位で、1ミックスがWebサイトやアプリ上で表示される1曲に相当します。
新しい曲を投稿する際の最小単位は、1トラック＋1ミックスです。
1トラックの録音ができたら、そのファイルをトラック投稿でアップロードし、 取得したタグIDと同じファイルをミックス投稿でアップロードしてください。

ミックス情報取得

ミックス(=楽曲)1件の情報を取得します。
HTTPメソッド
GET
URL
https://melocy.com/ma/mix/info/{mix_id}
アプリケーション登録
不要

パラメータ

mix_id 必須 ミックスID

戻り値

mix_id ミックスID
title タイトル
desc ひとこと
date 投稿日時
user_id 投稿ユーザーのID
url オーディオファイルのURL
オーディオファイルはユーザーが直接操作できないよう、扱いにご注意ください
bpm テンポ（float）
duration 再生時間
count ダウンロードカウント
cool_times COOL!された時刻（ミリ秒単位）
relations 関連ミックスの情報（コレクション、ミックス情報と同一）
tracks ミックスに含まれるトラックの情報（コレクション）
　part トラックのパート
　user_id トラックを投稿したユーザーのID
　name トラックを投稿したユーザーの名前
tags ミックスに付けられたタグの情報（コレクション）
　name タグ名
　create_user タグを付けたユーザーのID

例

https://melocy.com/ma/mix/info/8eb5169d-e1cd-4cf3-909e-7d45fca48c47 ページトップ

ミックス絞り込み検索

指定した条件で、ミックスを絞り込み検索します。
条件に一致したミックスのうち、ランダムで1件のミックス情報を取得します。
一致するミックスがない場合、nullを返します。
HTTPメソッド
GET
URL
https://melocy.com/ma/mix/search/{conditions}
アプリケーション登録
不要

パラメータ

conditions 必須 絞り込み条件（JSON形式、配列：下記参照）
各条件はAND検索となります。

conditions

type 必須 string 条件タイプ（Text/Plays/Cools/Part/Duration）
equation 必須 string 条件式（equals/less/great/contains/not_contains：タイプによって異なる）
value 必須 string 条件値
テキスト検索（type = Text）
ミックスのタイトル(title)またはひとこと(desc)からテキスト検索します。
equals valueと一致するミックスを検索します。
contains valueを含むミックスを検索します。
not_contains valueを含まないミックスを検索します。
再生回数検索（type = Plays）
ミックスの再生回数から検索します。
equals 再生回数がvalueと一致するミックスを検索します。
less 再生回数がvalueより少ない(<)ミックスを検索します。
great 再生回数がvalueより多い(>)ミックスを検索します。
Cool数検索（type = Cool）
ミックスのCool数から検索します。
equals Cool数がvalueと一致するミックスを検索します。
less Cool数がvalueより少ない(<)ミックスを検索します。
great Cool数がvalueより多い(>)ミックスを検索します。
パート検索（type = Part）
ミックスが含むパートから検索します。
パート：vocal/guitar/bass/drums/percussion/keyboard/brass/lead/strings/other
contains valueを含むミックスを検索します。
not_contains valueを含まないミックスを検索します。
録音時間検索（type = Duration）
ミックスの録音時間(単位：秒)から検索します。
equals 録音時間がvalueと一致するミックスを検索します。
less 録音時間がvalueより少ない(<)ミックスを検索します。
great 録音時間がvalueより多い(>)ミックスを検索します。
アーティスト検索（type = Artist）
ミックスの原曲をリリースしているアーティストから検索します。
equals valueと一致するアーティストのミックスを検索します。
contains valueを含むアーティストのミックスを検索します。

戻り値

ミックス情報取得を参照

例

https://melocy.com/ma/mix/search?conditions=[{"type":"Text","equation":"contains","value":"千本桜"},{"type":"Cools","equation":"great","value":"140"}] ページトップ

ミックスタイトル検索

melocyで公開されているミックス(=楽曲)を検索します。
HTTPメソッド
GET
URL
https://melocy.com/ma/search/{keyword}
アプリケーション登録
不要

パラメータ

keyword 省略可（全件ヒット） 検索キーワード
page 省略可（0） ページ番号（0～）
count 省略可（20） 取得件数

戻り値

found_count 検索結果の総件数
mixes 1ページ分のミックス情報（コレクション、ミックス情報取得の形式に準じる）

例

https://melocy.com/ma/search/title/空?page=2&count=5 ページトップ

ミックスタグ検索

melocyで公開されているミックス(=楽曲)を検索します。
HTTPメソッド
GET
URL
https://melocy.com/ma/search/tag/{keyword}
アプリケーション登録
不要

パラメータ

keyword 省略可（全件ヒット） 検索キーワード
page 省略可（0） ページ番号（0～）
count 省略可（20） 取得件数

戻り値

found_count 検索結果の総件数
mixes 1ページ分のミックス情報（コレクション、ミックス情報取得の形式に準じる）

例

https://melocy.com/ma/search/tag/ポップ?page=2&count=5 ページトップ

タグ取得

登録されている全てのタグを取得します。
HTTPメソッド
GET
URL
https://melocy.com/ma/tag/tags/
アプリケーション登録
不要

パラメータ

なし

戻り値

タグ名のコレクション

例

https://melocy.com/ma/tag/tags/ ページトップ

関連タグ取得

指定されたタグと一緒に付けられている、関連タグを取得します。
HTTPメソッド
GET
URL
https://melocy.com/ma/tag/relations/{tag_name}
アプリケーション登録
不要

パラメータ

tag_name タグ名

戻り値

関連タグ名のコレクション(最大20件)

例

https://melocy.com/ma/tag/relations/ロック ページトップ

トラック投稿

トラックを新規に投稿します。
HTTPメソッド
POST(multipart/form-data)
URL
https://melocy.com/ma/track/add
アプリケーション登録
必要（ユーザーログインで取得した認証チケットを、Cookieに設定してください）

パラメータ

app_key 必須 アプリケーションキー(こちらから登録ください)
track_info 必須 トラック情報（JSON形式：下記参照）
track_file 必須 投稿する音声ファイル（モノラルm4a形式、160kbps推奨）

track_info

bpm 必須 float トラックのテンポ（BPM）
duration 必須 string トラックの長さ（"mm:ss"形式）
part 必須 string パート（vocal,guitar,bass,drum,percussion,keyboard,brass,lead,strings,other）

戻り値

登録したトラックのID

セッション管理について

ユーザーログインで取得した認証チケットを、Cookieに設定してください。

ページトップ

ミックス投稿

ミックスを新規に投稿します。
HTTPメソッド
POST(multipart/form-data)
URL
https://melocy.com/ma/mixup/add
アプリケーション登録
必要（ユーザーログインで取得した認証チケットを、Cookieに設定してください）

パラメータ

app_key 必須 アプリケーションキー(こちらから登録ください)
mix_info 必須 ミックス情報（JSON形式：下記参照）
mix_file 必須 投稿する音声ファイル（モノラルm4a形式、160kbps推奨）

mix_info

bpm 必須 float ミックスのテンポ（BPM）
duration 必須 string ミックスの長さ（"mm:ss"形式）
title 必須 string ミックスのタイトル
description 必須 string 説明テキスト
base_mix_id 省略可 string 親ミックスのID(Guid)
tags 省略可 string[] ミックスに付加するタグの配列
tracks 必須 string[] ミックスが収録しているトラックのID配列

戻り値

登録したミックスのID

ページトップ

ミックス投稿(サンドボックス)

サンドボックスモードでミックスを新規に投稿します。投稿したミックスは、非公開状態となります。
APIアドレスが「add」と「add_sand」である以外、通常モードの投稿APIと全て同一です。
HTTPメソッド
POST(multipart/form-data)
URL
https://melocy.com/ma/mixup/add_sand
アプリケーション登録
必要（ユーザーログインで取得した認証チケットを、Cookieに設定してください）

パラメータ

app_key 必須 アプリケーションキー(こちらから登録ください)
mix_info 必須 ミックス情報（JSON形式：下記参照）
mix_file 必須 投稿する音声ファイル（モノラルm4a形式、160kbps推奨）

mix_info

bpm 必須 float ミックスのテンポ（BPM）
duration 必須 string ミックスの長さ（"mm:ss"形式）
title 必須 string ミックスのタイトル
description 必須 string 説明テキスト
base_mix_id 省略可 string 親ミックスのID(Guid)
tags 省略可 string[] ミックスに付加するタグの配列
tracks 必須 string[] ミックスが収録しているトラックのID配列

戻り値

登録したミックスのID

ページトップ

ユーザー情報取得

ユーザーの情報を取得します。
HTTPメソッド
GET
URL
https://melocy.com/ma/user/info/{user_id}
アプリケーション登録
不要

パラメータ

user_id 必須 ユーザーID

戻り値

id ユーザーID
name ユーザー名
desc ひとこと
image アイコン画像（空白/未設定の場合、ユーザーアイコン画像をご利用ください）
parts 投稿したことのあるパート（コレクション）
twitter Twitter登録の有無（bool）
twitter_name Twitterアカウントの名前
facebook Facebook登録の有無（bool）
facebook_name Facebookアカウントの名前

例

https://melocy.com/ma/user/info/1003 ページトップ

ユーザーログイン

ユーザーの認証、ログインを行います。
HTTPメソッド
GET
URL
https://melocy.com/ma/user/login?app_key={app_key}&email={email}&password={password}
アプリケーション登録
必要

パラメータ

app_key 必須 アプリケーションキー(こちらから登録ください)
email 必須 メールアドレス
password 必須 パスワード

戻り値

ユーザー情報取得を参照

セッション管理について

ASP.NETの認証チケット「.ASPXAUTH」がクッキーとして戻ります。 この「.ASPXAUTH=」を含むチケットを、認証が必要なAPIにクッキーとして渡してください。

例

https://melocy.com/ma/user/login?app_key=hogehoge&email=hoge@melocy.com&password=hogehoge ページトップ

ユーザーログアウト

ログアウトを行います。
HTTPメソッド
GET
URL
https://melocy.com/ma/user/logout
アプリケーション登録
不要

パラメータ

なし

戻り値

なし

セッション管理について

ログインしている状態でこのAPIをコールすると、ログイン状態が解消され、Cookieが無効になります。

例

https://melocy.com/ma/user/logout ページトップ

ユーザーアイコン画像

ユーザーアイコンが設定されていない場合の規定値として、ご利用ください。
melocy APIを利用した作品内でのみ、ご利用いただけます
HTTPメソッド
GET
URL
https://melocy.com/images/user/userDefault.png
アプリケーション登録
不要

例

http://melocy.com/images/user/userDefault.png user default ページトップ