JSON API

概要

JSON APIへは、http://www.illustbook.net/api_クラス名?method=関数名&引数、でアクセスします。返り値はJSONオブジェクトです。外部サーバからアクセスする場合は、通常のgetメソッドで問題ありませんが、ローカルのJavaScriptからアクセスされる場合、クロスドメイン制約を回避する必要があります。そこで、APIアクセスの引数の最後に、callback=関数名、を追加することでJSONPでアクセスすることができます。

イラストブックのJavaScript APIでは、ネットワークアクセスAPIが提供されており、同じドメインの場合は通常のget、それ以外の場合はJSONPを自動的に選択して、JSON APIにアクセスしています。JavaScript APIを使用してJSON APIにアクセスする例を、次に示します。

function test_jsonp(){
	user_id=illustbook.user.getCurrentUser()
	var api_url="http://www.illustbook.net/api_user"
	illustbook.request.get(api_url+"?method=getProfile&user_id="+user_id,test_callback)
}
	
function test_callback(oj){
	alert(oj.response.name);
}

この例ではapi_userにアクセスしていますが、get関数が自動的に、http://www.illustbook.net/api_user?method=getProfile&user_id=xxx&callback=my_callback、という形式に変換してscriptタグを動的に生成して、処理結果をmy_callbackに通知します。

コールバックには次のプロパティを持つオブジェクトが通知されます。通知されるオブジェクトは、JavaScript APIとJSON APIで共通です。

クラスとオブジェクト一覧

>クラス一覧

>オブジェクト一覧

feedクラスではイラストブックの最新情報を取得することができます。次の例では、最近追加されたイラストのタイトルを表示します。

function test_feed(){
	user_id=illustbook.user.getCurrentUser()
	var api_url="http://www.illustbook.net/api_feed"
	var args="offset=0&limit=1&order=new"
	illustbook.request.get(api_url+"?method=getThreadList&"+args,feed_callback)
}
	
function feed_callback(oj){
	var thread_list=oj.response;
	alert(thread_list[0].title);
}

userクラスではイラストブックのユーザ情報を取得することができます。

bookmarkクラスでは、ユーザをキーとしてブックマークしているイラストを取得したり、イラストをキーにしてブックマークしているユーザを取得するこができます。

perpetuationクラスでは、イラストブックにデータを保存したり、イラストブックからデータを読み込んだりすることができます。保存形式はキーバリューストアとなり、実データの文字列と一緒に、データのソートのための数値を格納することができます。保存時にはユーザアカウントとアプリIDを認証するため、他のユーザのデータや、他のアプリのデータを書き換えることはできません。また、ローカル環境からは動作しません。

次の例では、"test_data"という名前でデータの保存を行なっています。

function test_put_data(){
    var data_obj=[];
    data_obj.int_data=10;
    data_obj.text_data="test";

    app_key=illustbook.app.getAppKey();
    user_id=illustbook.user.getCurrentUser();
    data_key="test_data";
    args="app_key="+app_key+"&user_id="+user_id+"&data_key="+data_key;
    illustbook.request.post("api_perpetuation?method=putData&"+args,data_obj,put_data_callback);
};

function put_data_callback(oj){
    alert("put:"+oj.status);
}

次の例では、"test_data"という名前からデータの読込を行なっています。

function test_get_data(){
    app_key=illustbook.app.getAppKey();
    user_id=illustbook.user.getCurrentUser();
    data_key="test_data";
    args="app_key="+app_key+"&user_id="+user_id+"&data_key="+data_key;
    illustbook.request.get("api_perpetuation?method=getData&"+args,get_data_callback);
}

function get_data_callback(oj){
    alert("get:"+oj.status+" int_data:"+oj.response.int_data+" text_data:"+oj.response.text_data);
}

また、アプリケーションの設定においてランキングに使用するdata_keyを指定することで、自動的にアプリにユーザランキングを追加することができます。ランキングはint_dataでソートされ、text_dataが画面に表示されます。

threadオブジェクトにはイラストの情報が入ります。イラストからブックマークを検索する場合はthreadオブジェクトのkeyプロパティを使用します。

bbsオブジェクトにはボードの情報が入ります。

appオブジェクトにはアプリの情報が入ります。

feedオブジェクトにはフィードの情報が入ります。

userオブジェクトにはユーザの情報が入ります。メールアドレスは取得できません。

perpetuation_dataオブジェクトにはperpetuaion apiで保存したデータが返ります。

JSON APIは同一IPから3秒間に10回までアクセスすることができます。それを超えた場合は自動的にovercapacityエラーが返ります。アクセス制限はサーバの負荷に応じて今後変更される可能性があります。

次のページ(JavaScript API)

前のページ(プラットフォームの概要)

デベロッパーポータルへ戻る