ランこれ|みんなで作る人気投票のランキング総合サイト

このエントリーをはてなブックマークに追加

ランこれAPIとは

ランこれAPIとは、ランこれのランキング(人気投票)情報の取得や作成・編集などの機能をAPIで提供するサービスです。

ご承諾事項

当サービスのご利用にあたり、利用規約をご一読いただき、準拠した内容でご利用ください。

はじめに(導入)

ランこれAPIを使用するには、ランこれのアカウントとトークンが必要となります。以下の手順にしたがってトークンを取得してください。

  • ランこれのアカウントを作成します。
  • マイページの「プロフィールを編集する」をクリックし、プロフィール編集画面を開きます。
  • ランこれAPI欄の「使用する」ボタンをクリックします。
  • トークンが発行されます。

APIリファレンス

ランこれAPIの操作は、以下のベースURLに必要なパラメータをPOSTで付与して送信することで各種機能を提供します。

POST https://rancolle.com/exe/api.php

認証用 必須パラメータ

認証に必要となるパラメータです。すべての操作で必要となります。

パラメータ名 値の種類 説明
id string [必須]ユーザーID
token string [必須]トークン
request string [必須]各種APIの呼び出し値

※ ランキングの情報取得のみ、本内容に従いません。詳しくはランキングの情報取得 項をお読みください。

機能

ランキングの作成

新しく投票形式のランキングを作成します。

request の値

create_vote

各パラメータ

パラメータ名 値の種類 説明
data json [必須]ランキングの詳細情報を格納したjsonデータ

data jsonデータ

パラメータ名 値の種類 説明
title string [必須]ランキングのタイトル
description string [必須]ランキングの説明文
category integer [必須]ランキングのカテゴリー
0=本、1=漫画、2=ゲーム、3=アニメ、4=テレビ、5=映画、6=ホビー、7=教育、8=趣味、9=ファッション、10=食事、11=スポーツ、12=旅行、13=車・バイク、14=暮らし、15=ビジネス、16=地域、17=ネタ
maxvotes integer [必須]ランキングの投票受付数
設定可能数: 100、300、500、1000、3000、5000、10000
tag_a string タグ(1つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_b string タグ(2つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_c string タグ(3つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_d string タグ(4つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_e string タグ(5つ目)
一部を除いて記号は使えません。(例外 ― ・. )
image string 画像のURL
これを付与する場合、img_source と img_owner の付与が必須
img_source string 画像の引用先
image を付与する場合、[必須]
img_owner string 画像の著作権者
image を付与する場合、[必須]
edit_flag integer ランキングの編集設定
0=自分のみが編集可能 1=誰でも編集可能
add_item integer 投票項目の追加設定
0=自分のみが追加可能 1=誰でも追加可能
edit_item integer 投票項目の編集設定
0=投稿者のみが編集可能 1=誰でも編集可能
restart integer 投票終了後の自動再開設定
0=再開しない 1=再開する
cmt_setting integer 投票項目コメント設定
0=投票した人のみ、その項目にコメントができる
1=ログインしている人と投票した人のみ、その項目にコメントができる
2=誰でも項目にコメントができる
item_name array 投票項目の名称

送信パラメータの例

?id=uid54
&token=1234567890abcdefghijklmnopqrstuv
&request=create_vote
&data={"title":"\u30b5\u30f3\u30d7\u30eb\u4eba\u6c17\u6295\u7968","description":"\u30b5\u30f3\u30d7\u30eb\u306e\u4eba\u6c17\u6295\u7968\u3067\u3059\u3002","category":"0","maxvotes":"100","image":"https:\/\/rancolle.com\/image\/sumple1.jpg","img_source":"\u30e9\u30f3\u3053\u308c","img_owner":"\u30e9\u30f3\u3053\u308c\u904b\u55b6","item_name":["\u6295\u7968\u9805\u76ee1","\u6295\u7968\u9805\u76ee2","\u6295\u7968\u9805\u76ee3"]}

レスポンス

送信結果がjsonデータで返されます。成功した場合、success と id が返されます。

レスポンスの例

{
  "success": "ランキングの作成は完了しました。",
  "id": "uid54_123456789"
}

ランキングの編集

ランキングの詳細情報を編集します。

request の値

create_vote

各パラメータ

パラメータ名 値の種類 説明
data json [必須]ランキングの詳細情報を格納したjsonデータ

data jsonデータ

パラメータ名 値の種類 説明
id string [必須]編集をするランキングのID
title string ランキングのタイトル
description string ランキングの説明文
category integer ランキングのカテゴリー
0=本、1=漫画、2=ゲーム、3=アニメ、4=テレビ、5=映画、6=ホビー、7=教育、8=趣味、9=ファッション、10=食事、11=スポーツ、12=旅行、13=車・バイク、14=暮らし、15=ビジネス、16=地域、17=ネタ
maxvotes integer ランキングの投票受付数
設定可能数: 100、300、500、1000、3000、5000、10000
tag_a string タグ(1つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_b string タグ(2つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_c string タグ(3つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_d string タグ(4つ目)
一部を除いて記号は使えません。(例外 ― ・. )
tag_e string タグ(5つ目)
一部を除いて記号は使えません。(例外 ― ・. )
image string 画像のURL
これを付与する場合、img_source と img_owner の付与が必須
img_source string 画像の引用先
image を付与する場合、[必須]
img_owner string 画像の著作権者
image を付与する場合、[必須]
edit_flag integer ランキングの編集設定
0=自分のみが編集可能 1=誰でも編集可能
add_item integer 投票項目の追加設定
0=自分のみが追加可能 1=誰でも追加可能
edit_item integer 投票項目の編集設定
0=投稿者のみが編集可能 1=誰でも編集可能
restart integer 投票終了後の自動再開設定
0=再開しない 1=再開する
cmt_setting integer 投票項目コメント設定
0=投票した人のみ、その項目にコメントができる
1=ログインしている人と投票した人のみ、その項目にコメントができる
2=誰でも項目にコメントができる

送信パラメータの例

?id=uid54
&token=1234567890abcdefghijklmnopqrstuv
&request=create_vote
&data={"id":"uid54_123456789","description":"\u30b5\u30f3\u30d7\u30eb\u306e\u4eba\u6c17\u6295\u7968\u3067\u3059\u3002"}

レスポンス

送信結果がjsonデータで返されます。成功した場合、success と id が返されます。

レスポンスの例

{
  "success": "ランキングの編集は完了しました。",
  "id": "uid54_123456789"
}

ランキングの削除

ランキングを削除します。

request の値

delete_vote

各パラメータ

パラメータ名 値の種類 説明
data json [必須]ランキングの詳細情報を格納したjsonデータ

data jsonデータ

パラメータ名 値の種類 説明
id string [必須]削除をするランキングのID

送信パラメータの例

?id=uid54
&token=1234567890abcdefghijklmnopqrstuv
&request=delete_vote
&data={"id":"uid54_123456789"}

レスポンス

送信結果がjsonデータで返されます。成功した場合、success と id が返されます。

レスポンスの例

{
  "success": "ランキングの削除が完了しました。",
  "id": "uid54_123456789"
}

投票項目の追加

指定のランキングに新しく投票項目を追加します。

request の値

create_item

各パラメータ

パラメータ名 値の種類 説明
data json [必須]投票項目の詳細情報を格納したjsonデータ

data jsonデータ

パラメータ名 値の種類 説明
ranking_id string [必須]ランキングのID
title string [必須]投票項目の名称
summary string 投票項目の説明文
image string 画像のURL
これを付与する場合、img_source と img_owner の付与が必須
img_source string 画像の引用先
image を付与する場合、[必須]
img_owner string 画像の著作権者
image を付与する場合、[必須]

送信パラメータの例

?id=uid54
&token=1234567890abcdefghijklmnopqrstuv
&request=create_item
&data={"ranking_id":"uid54_123456789","title":"\u6295\u7968\u9805\u76ee1","summary":"\u6295\u7968\u9805\u76ee1\u3067\u3059\u3002","image":"https:\/\/rancolle.com\/image\/sumple1.jpg","img_source":"\u30e9\u30f3\u3053\u308c","img_owner":"\u30e9\u30f3\u3053\u308c\u904b\u55b6"}

レスポンス

送信結果がjsonデータで返されます。成功した場合、success と id が返されます。

レスポンスの例

{
  "success": "投票項目の作成は完了しました。",
  "id": "uid54_234567890"
}

投票項目の編集

投票項目を編集します。

request の値

create_item

各パラメータ

パラメータ名 値の種類 説明
data json [必須]投票項目の詳細情報を格納したjsonデータ

data jsonデータ

パラメータ名 値の種類 説明
ranking_id string [必須]ランキングのID
id string [必須]投票項目のID
title string 投票項目の名称
summary string 投票項目の説明文
image string 画像のURL
これを付与する場合、img_source と img_owner の付与が必須
img_source string 画像の引用先
image を付与する場合、[必須]
img_owner string 画像の著作権者
image を付与する場合、[必須]

送信パラメータの例

?id=uid54
&token=1234567890abcdefghijklmnopqrstuv
&request=create_item
&data={"ranking_id":"uid54_123456789","id":"uid54_234567890","summary":"\u6295\u7968\u9805\u76ee1\u3067\u3059\u3002"}

レスポンス

送信結果がjsonデータで返されます。成功した場合、success と id が返されます。

レスポンスの例

{
  "success": "投票項目の編集は完了しました。",
  "id": "uid54_234567890"
}

投票項目の削除

投票項目を削除します。

request の値

delete_item

各パラメータ

パラメータ名 値の種類 説明
data json [必須]投票項目の詳細情報を格納したjsonデータ

data jsonデータ

パラメータ名 値の種類 説明
ranking_id string [必須]ランキングのID
id string [必須]削除をする投票項目のID

送信パラメータの例

?id=uid54
&token=1234567890abcdefghijklmnopqrstuv
&request=delete_item
&data={"ranking_id":"uid54_123456789","id":"uid54_234567890"}

レスポンス

送信結果がjsonデータで返されます。成功した場合、success と id が返されます。

レスポンスの例

{
  "success": "投票項目の削除が完了しました。",
  "id": "uid54_234567890"
}

ランキングの情報取得

ランキングの掲載に必要な情報を提供します。

APIリファレンス

ランキングの情報取得は、以下のベースURLに必要なパラメータをPOSTで付与して送信することで情報を提供します。

POST https://rancolle.com/exe/custom-embed.php

各パラメータ

パラメータ名 値の種類 説明
id string [必須]ランキングのID
img integer 投票項目の画像ファイル名の取得フラグ
0=取得しない 1=取得する
smy integer 投票項目の説明文の取得フラグ
0=取得しない 1=取得する

送信パラメータの例

?id=uid54_123456789
&img=1
&smy=1

レスポンス

送信結果がjsonデータで返されます。

パラメータ名 値の種類 説明
title string ランキングのタイトル
start_time integer 投票開始日 (Unix time stamp)
end_time integer 投票終了日 (Unix time stamp)
maxvotes integer 投票受付数
description string ランキングの説明文
image string ランキングのトップ画像ファイル名
items array 投票項目データ

投票項目データ

パラメータ名 値の種類 説明
id string 投票項目のID
name string 投票項目の名称
votes integer 投票項目の投票数
rank integer 投票項目の順位
summary string 投票項目の説明文
image string 投票項目の画像ファイル名

各画像のURL

ランキングのトップ画像

https://rancolle.com/images/ranking/{ranking_id}/{image_file}

投票項目の画像

https://rancolle.com/images/item/{item_id}/{image_file}

投票ボタンを設置する

以下のAPIリファレンスに従って、投票機能を提供します。
またブログパーツを使うことで簡単に機能を実装できます。詳しくはブログパーツの解説を参照ください。

APIリファレンス

投票ボタンを押した際、以下のベースURLに必要なパラメータを付与し、POSTでの画面遷移をすることで機能提供します。

POST https://rancolle.com/vote.php

各パラメータ

パラメータ名 値の種類 説明
ranking_id string [必須]ランキングのID
id string [必須]投票をする投票項目のID
callback string コールバック先のURL

画面の遷移

投票ボタンを押すと https://rancolle.com/vote.php にクライアントは画面が遷移し、戻るボタンを押すことでコールバックされます。

投票時の画面遷移

※ パラメータ callback を指定した場合は、指定のURLにコールバックします。指定しない場合は、投票ボタンを押したページに戻ります。

レスポンス

レスポンスがgetデータで返されます。成功した場合、戻り値なし。失敗時は error が返ります。