
同期歌詞取得API
概要
プチリリ®APIは株式会社シンクパワーの提供する”同期歌詞”※を検索、取得できるAPIです。
※同期歌詞とは時間情報が付与された歌詞のことです。
本APIに関してイベント開催前の提供に関するご相談や、その他ご質問などございましたら下記までお問い合わせ下さい。
お問い合わせ
https://www.syncpower.jp/inquiry.html
GET lyrics/list
キーワードから歌詞リスト・同期歌詞を検索するAPIです。
Resource URL
https://****/mh/1/lyrics/list.xml
接続先のホスト名は当日の公開となります。Resource Information
フォーマット | XML |
認証 | 必要 |
Authentication Information
認証キーをauth_keyパラメータに指定してください。
Parameters
No. | 項目名 | 必須/オプション | 長さ/値 | 補足 |
---|---|---|---|---|
1 | lyrics_id | 1~5のいずれかが必須 | 1-9999999 | 歌詞を特定する一意のIDです。 Example Values: 12345 |
2 | title | 1~5のいずれかが必須 | 128文字 | 楽曲名を指定します。指定された値は前方一致の条件で検索を行います。 Example Values: 鶏肉と塩コショウ |
3 | artist | 1~5のいずれかが必須 | 128文字 | アーティスト名を指定します。指定された値は前方一致の条件で検索を行います。 Example Values: 倉沢 桃子 |
4 | album | 1~5のいずれかが必須 | 128文字 | アルバム名を指定します。指定された値は前方一致の条件で検索を行います。 Example Values: 体温 |
5 | lyrics_text | 1~5のいずれかが必須 | 128文字 | 歌詞の一部を指定します。指定された値は部分一致の条件で検索を行います。 Example Values: 塩コショウで焼く |
6 | duration | オプション | 0-600000(ms) | 再生時間です。指定が無い場合は再生時間を比較せずに同期歌詞を返却、 再生時間が一致(+-3秒以内)しない場合はテキスト歌詞が返却されます。 Example Values: 173000 |
7 | priority | オプション (Default : 3) |
1-3 | 歌詞タイプの取得優先度 (1:テキスト歌詞、2:行単位、3:文節単位) Example Values: 3 |
8 | auth_key | 必須 | 128文字 | 認証キーを指定してください。 Example Values: dlzqBhK85gJ7INXCH3ktVTiCjirfmot6 |
Example Request
https://xxxx/mh/1/lyrics/list.xml?title=%e9%b6%8f%e8%82%89%e3%81%a8%e5%a1%a9%e3%82%b3%e3%82%b7%e3%83%a7%e3%82%a6
&artist=%e5%80%89%e6%b2%a2%20%e6%a1%83%e5%ad%90
&album=%e4%bd%93%e6%b8%a9
&lyrics_text=%89%96%83R%83V%83%87%83E%82%c5%8f%c4%82%ad
&duration=173000
&priority=3
&auth_key=dlzqBhK85gJ7INXCH3ktVTiCjirfmot6
Example Result
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>00000000</status>
<songs>
<name>HACKATHON</name>
<date>2014-11-18 15:06:15</date>
<matchedCount>2</matchedCount>
<returnedCount>2</returnedCount>
<song>
<order>1</order>
<lyricsId>183676</lyricsId>
<title>一人じゃないから</title>
<artistId>1114</artistId>
<artist>古瀬 陽子</artist>
<album>君を抱きしめたい</album>
<jancode/>
<isrc/>
<writer>古瀬陽子</writer>
<composer>古瀬陽子</composer>
<duration>302000</duration>
<lyricsType>3</lyricsType>
<availableLyricsType>3</availableLyricsType>
<prefferedLyricsType>3</prefferedLyricsType>
<lyricsData>PHdzeT48bGluZW51bT40MTwvbGluZW51...</lyricsData>
<postUserId>syncpower</postUserId>
<postUserName>PetitLyrics</postUserName>
<kashiMesse>0</kashiMesse>
<viewCount>1</viewCount>
<copyright>0</copyright>
<uploadDate>2011-08-19</uploadDate>
<releaseDate/>
</song>
<song>
<order>2</order>
<lyricsId>106769</lyricsId>
<title>一人じゃないから</title>
<artistId>1114</artistId>
<artist>古瀬 陽子</artist>
<album>君を抱きしめたい</album>
<jancode/>
<isrc/>
<writer>古瀬 陽子</writer>
<composer>古瀬 陽子</composer>
<duration>301530</duration>
<lyricsType>2</lyricsType>
<availableLyricsType>2</availableLyricsType>
<prefferedLyricsType>3</prefferedLyricsType>
<lyricsData/>
<postUserId>kikuchi</postUserId>
<postUserName>kikuchi</postUserName>
<kashiMesse>0</kashiMesse>
<viewCount>1</viewCount>
<copyright>0</copyright>
<uploadDate>2010-09-08</uploadDate>
<releaseDate/>
</song>
</songs>
</response>
Example Result (Lyrics Data)
返却した歌詞リストの1件目にのみ、json形式の歌詞データが付与されます。タグ名はlyricsDataです。歌詞の種別によってjsonのデータ構造は異なります。
{
"lines": [
{
"time": 24540,
"words": [
{
"end": 26140,
"start": 24540,
"string": "ざわめい"
},
{
"end": 26600,
"start": 26170,
"string": "た"
},
{
"end": 27530,
"start": 26630,
"string": "街"
},
{
"end": 27930,
"start": 27570,
"string": "を"
}
]
},
{
"time": 30310,
"words": [
{
"end": 30540,
"start": 30310,
"string": "一"
},
{
"end": 31450,
"start": 30840,
"string": "歩"
},
{
"end": 33280,
"start": 31640,
"string": "踏みしめ"
},
{
"end": 34360,
"start": 33310,
"string": "歩い"
},
{
"end": 34810,
"start": 34530,
"string": "て"
},
{
"end": 36230,
"start": 34870,
"string": "みる"
}
]
}
~~省略~~
],
"type": 3
}
HTTP Status Code
APIでは下記のステータスコードを返却します。ステータスコード | レスポンスメッセージ | 意味 |
---|---|---|
200 | OK | 成功 |
400 | Bad Request | リクエストされた値に不正値があります |
401 | Authorization Required | 認証に失敗しました |
403 | Forbidden | アクセス権がありません |
405 | Method Not Allowed | メソッドが許可されていません |
429 | Too Many Requests | リクエスト回数の上限値に達しています(新しいキーを発行しますので、担当者までお問い合わせください) |
500 | Internal Server Error | API側の問題で失敗しました |
503 | Service Unavailable | 一時的にアクセスができませんでした |
Error Message
HTTPステータスコードが200以外の場合は、statusとmessageを返却します。ステータスコード | エラーメッセージ | 補足 |
---|---|---|
40500001 | メソッドが許可されていません | GETメソッドでリクエストしてください |
40300001 | アクセス権がありません | 正しい認証キーを設定してください |
40100001 | 認証に失敗しました | 認証キーを設定してください |
40000001 | 必須パラメータが設定されていません | パラメータNo.1~4のいずれかは必ず設定する必要があります |
40001001 | lyrics_idの値を正しく設定してください | 1~9999999の整数値を設定してください |
40002001 | titleの値を正しく設定してください | 128文字以内で設定してください |
40003001 | artistの値を正しく設定してください | 128文字以内で設定してください |
40004001 | albumの値を正しく設定してください | 128文字以内で設定してください |
40009001 | lyrics_textの値を正しく設定してください | 128文字以内で設定してください |
40005001 | durationの値を正しく設定してください | 0~600000(ms)の整数値を設定してください |
40006001 | priorityの値を正しく設定してください | 1~3の整数値を設定してください |
40007001 | auth_keyの値を正しく設定してください | 128文字以内で設定してください |
40008001 | リクエスト回数の上限値に達しています | 新しいキーを発行しますので、担当者までお問い合わせください |
Example Result (Error Message)
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>40500001</status>
<message>メソッドが許可されていません</message>
</response>