目次
Stickam JAPAN! Data API（以下、Data API）を利用して、Stickam JAPAN!（以下、スティッカム）の様々なデータを取得することができます。ユーザーやメディアを様々な条件で検索したり、詳細なプロフィール情報を取得したり、ライブ録画やアップロードされている動画・画像・音楽の詳細な情報を取得したりすることも可能です。
Data APIの全てのレスポンスフォーマットは"XML"および"JSON(JSONP)"に対応し、多くのプログラミング言語で扱うことができます。
特定ユーザのStickamユーザ名(user_name)からそのユーザのプロフィール情報が取得できます。
<ユーザ名>は必須項目です。
http://api.stickam.jp/api/user/<ユーザ名>/profile
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| <ユーザ名> | Stickamユーザ名 | string | |
| mime | ファイル形式 | "xml", "json" | 未指定の場合はXML |
| callback | コールバック | string | mime=jsonの時のみ有効 |
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| user_id | StickamユーザID | Num | |
| user_name | Stickamユーザ名 | string | |
| screen_name | Stickam表示名 | string | |
| reg_date | 登録日 | YYYY-MM-DD | |
| country | 居住国 | string | |
| zipcode | 郵便番号(未使用) | string | |
| liveTag | ライブタグ | string | userCategory(ユーザカテゴリー) を参照 |
| userCategory | ユーザカテゴリー | "1", "2", "3", "4", "5", "6" | |
| message | メッセージ | string | |
| status | ユーザの状態 | "live", "chat", "online", "offline" | status(ユーザの状態) を参照 |
| last_login | 最終ログイン日時 | YYYY-MM-DD hh:mm:ss | |
| profile_url | ユーザプロフィールページのURL | string | |
| profile_image | プロフィール画像のURL | string | |
| page_views | プロフィールページ閲覧数 | Num | |
| image_count | ユーザアップロード画像ファイル数 | Num | |
| video_count | ユーザアップロード動画ファイル数 | Num | |
| audio_count | ユーザアップロード音楽ファイル数 | Num | |
| friends_count | ユーザの友達登録人数 | Num | |
| playerN | ユーザ登録プレーヤーembedコード | string |
userCategory(ユーザカテゴリー)の1から6までの数字は、下表のように英語・日本語表記に対応します。
| 名前 | 英語表記 | 日本語表記 |
|---|---|---|
| 1 | business | ビジネス |
| 2 | life | 生活・暮らし |
| 3 | hobby | 趣味・スポーツ |
| 4 | entertainment | エンターテイメント |
| 5 | location | 風景・地域 |
| 6 | community | 友達・仲間 |
| 7 | other | ノンカテゴリ |
ユーザカテゴリーを使用したページとして、Stickam JAPAN!のユーザカテゴリーページは以下のようなタイトル・URLになっています。
| タイトル | URL |
|---|---|
| ビジネス - Stickam | http://www.stickam.jp/category/business |
Stickmaサイト上におけるユーザの状態を表します。
| 名前 | 意味 |
|---|---|
| live | ライブ中 |
| chat | チャット中 |
| online | オンライン |
| offline | オフライン |
特定ユーザのStickamユーザ名(user_name)からそのユーザが所有しているメディアファイル情報が取得できます。
Stickamで取り扱われるメディアファイルは以下の3つです。
<ユーザ名>および<メディアタイプ>は必須項目です。
http://api.stickam.jp/api/user/<ユーザ名>/<メディアタイプ>
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| <ユーザ名> | Stickamユーザ名 | string | |
| <メディアタイプ> | メディアのタイプ | "image", "video", "audio" | メディアタイプ を参照 |
| page | ページ番号 | Num | 未指定の場合は0 |
| per_page | 表示数 | Num | 未指定の場合は20 |
| mime | ファイル形式 | "xml", "json" | 未指定の場合はXML |
| callback | コールバック | string | mime=jsonの時のみ有効 |
| 名前 | 意味 |
|---|---|
| image | 画像ファイル |
| video | 動画ファイル |
| audio | 音楽ファイル |
下表は画像、動画、音楽ファイルに共通なレスポンスデータです。
その他、各メディア毎に固有のデータが付加されます。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| media_id | メディアID | string | |
| user_id | 所有者のStickamユーザID | string | |
| media_type | メディアのタイプ | "image", "video", "audio" | メディアタイプ を参照 |
| title | メディアのタイトル | string | |
| tag | メディアのタグ | string | |
| description | メディアの詳細 | string | |
| date | アップロード日時 | YYYY-MM-DD hh:mm:ss | |
| comment_count | コメント数 | Num | |
| rating_avg | 評価平均点 | Num | |
| rating_count | 評価数 | num |
下表は画像ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 参考 |
|---|---|---|---|
| thumb | メディアサムネイル画像URL | string | ヨコ80px タテ60px |
| small | メディアサムネイル画像URL(小) | string | ヨコ120px タテ90px |
| medium | メディアサムネイル画像URL(中) | string | ヨコ320px タテ240px |
| original | メディアサムネイル画像URL(オリジナルサイズ) | string |
下表は動画ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| thumb | メディアサムネイル画像URL | string | |
| duration | メディア再生時間(秒) | Num |
下表は音楽ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| artist | アーティスト名 | string | |
| duration | メディア再生時間(秒) | Num |
特定メディアのIDからメディア情報が取得できます。
<メディアID>は必須項目です。
http://api.stickam.jp/api/media/<メディアID>
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| <メディアID> | メディアのID | string | |
| mime | ファイル形式 | "xml", "json" | 未指定の場合はXML |
| callback | コールバック | string | mime=jsonの時のみ有効 |
下表は画像、動画、音楽ファイルに共通なレスポンスデータです。
その他、各メディア毎に固有のデータが付加されます。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| media_id | メディアID | string | |
| user_id | 所有者のStickamユーザID | string | |
| user_name | 所有者のStickamユーザ名 | string | |
| screen_name | 所有者のStickam表示名 | string | |
| media_type | メディアのタイプ | "image", "video", "audio" | メディアタイプ を参照 |
| title | メディアのタイトル | string | |
| tag | メディアのタグ | string | |
| description | メディアの詳細 | string | |
| date | アップロード日時 | YYYY-MM-DD hh:mm:ss | |
| comment_count | コメント数 | Num | |
| rating_avg | 評価平均点 | Num | |
| rating_count | 評価数 | num | |
| media_url | メディアの閲覧ページ | string |
下表は画像ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 参考 |
|---|---|---|---|
| thumb | メディアサムネイル画像URL | string | ヨコ80px タテ60px |
| small | メディアサムネイル画像URL(小) | string | ヨコ120px タテ90px |
| medium | メディアサムネイル画像URL(中) | string | ヨコ320px タテ240px |
| original | メディアサムネイル画像URL(オリジナルサイズ) | string |
下表は動画ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| thumb | メディアサムネイル画像URL | string | |
| duration | メディア再生時間(秒) | Num |
下表は音楽ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| artist | アーティスト名 | string | |
| duration | メディア再生時間(秒) | Num |
ユーザ名などに含まれる文字列や性別、状態などをパラメータとして指定することで該当ユーザのプロフィール情報が取得できます。
http://api.stickam.jp/api/search/user
オプション http://api.stickam.jp/api/search/user?page=ページ番号&per_page=表示数 http://api.stickam.jp/api/search/user?mime=形式&callback=コールバック
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| name | 検索文字列 | string | Stickamユーザ名 および Stickam表示名 から検索 |
| gender | 性別 | "M", "F" | gender(性別) を参照 |
| lowerAge | 年齢下限 | Num | |
| upperAge | 年齢上限 | Num | |
| live | status : ライブ中 | "1", "0" | media, statusパラメータ を参照 |
| chat | status : チャット中 | "1", "0" | 〃 |
| online | status : オンライン | "1", "0" | 〃 |
| image | media : 画像ファイル所持 | "1", "0" | 〃 |
| video | media : 動画ファイル所持 | "1", "0" | 〃 |
| audio | media : 音楽ファイル所持 | "1", "0" | 〃 |
| per_page | 表示数 | Num | |
| page | ページ番号 | Num | |
| mime | ファイル形式 | "xml", "json" | 未指定の場合はXML |
| callback | コールバック | string | mime=jsonの時のみ有効 |
| 名前 | 意味 |
|---|---|
| M | 男性 |
| F | 女性 |
| 名前 | 意味 | |
|---|---|---|
| 1 | media | 該当メディアファイルを1つ以上所持しているユーザ |
| status | 該当ステータスのユーザ | |
| 0 | media | 該当メディアファイルを1つも所持していないユーザ |
| status | 該当ステータスでないユーザ | |
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| user_id | StickamユーザID | Num | |
| user_name | Stickamユーザ名 | string | |
| screen_name | Stickam表示名 | string | |
| reg_date | 登録日 | YYYY-MM-DD | |
| country | 居住国 | string | |
| zipcode | 郵便番号(未使用) | string | |
| message | メッセージ | string | |
| status | ユーザの状態 | "live", "chat", "online", "offline" | status(ユーザの状態)を参照 |
| last_login | 最終ログイン日時 | YYYY-MM-DD hh:mm:ss | |
| profile_url | ユーザプロフィールページのURL | string | |
| profile_image | プロフィール画像のURL | string | |
| page_views | プロフィールページ閲覧数 | Num | |
| image_count | ユーザ所持画像ファイル数 | Num | |
| video_count | ユーザ所持動画ファイル数 | Num | |
| audio_count | ユーザ所持音楽ファイル数 | Num |
タイトルや詳細などに含まれる文字列をパラメータとして指定することで該当メディアの情報が取得できます。
<メディアタイプ>は必須項目です。
http://api.stickam.jp/api/search/media?type=<メディアタイプ>
オプション http://api.stickam.jp/api/search/media?type=<メディアタイプ>&page=ページ番号&per_page=表示数 http://api.stickam.jp/api/search/media?type=<メディアタイプ>&mime=形式&callback=コールバック
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| <メディアタイプ> | メディアのタイプ | "image", "video", "audio" | メディアタイプ を参照 |
| text | 検索文字列 | string | メディアのタイトル, 詳細 から検索 |
| tag | 検索文字列 | string | メディアのタグから検索 |
| sort | 取得順 | "view", "date" | sort(取得順) を参照 未指定の場合はアップロード日時順("date") |
| per_page | 表示数 | Num | |
| page | ページ番号 | Num | |
| mime | ファイル形式 | "xml", "json" | 未指定の場合はXML |
| callback | コールバック | string | mime=jsonの時のみ有効 |
下表は画像、動画、音楽ファイルに共通なレスポンスデータです。
その他、各メディア毎に固有のデータが付加されます。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| media_id | メディアID | string | |
| user_id | 所有者のStickamユーザID | string | |
| user_name | 所有者のStickamユーザ名 | string | |
| screen_name | 所有者のStickam表示名 | string | |
| media_type | メディアのタイプ | "image", "video", "audio" | メディアタイプ を参照 |
| title | メディアのタイトル | string | |
| tag | メディアのタグ | string | |
| description | メディアの詳細 | string | |
| date | アップロード日時 | YYYY-MM-DD hh:mm:ss | |
| comment_count | コメント数 | Num | |
| rating_avg | 評価平均点 | Num | |
| rating_count | 評価数 | num | |
| media_url | メディアの閲覧ページ | string |
下表は画像ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 参考 |
|---|---|---|---|
| thumb | メディアサムネイル画像URL | string | ヨコ80px タテ60px |
| small | メディアサムネイル画像URL(小) | string | ヨコ120px タテ90px |
| medium | メディアサムネイル画像URL(中) | string | ヨコ320px タテ240px |
| original | メディアサムネイル画像URL(オリジナルサイズ) | string |
下表は動画ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| thumb | メディアサムネイル画像URL | string | |
| duration | メディア再生時間(秒) | Num |
下表は音楽ファイル固有のレスポンスデータです。
| 名前 | 意味 | 値 | 備考 |
|---|---|---|---|
| artist | アーティスト名 | string | |
| duration | メディア再生時間(秒) | Num |