Project

General

Profile

RestAPIv1 » History » Version 21

Version 20 (admin, 05/13/2014 06:25 PM) → Version 21/100 (admin, 05/13/2014 06:27 PM)

{{>toc}}

h1. The 3DCGARTS REST API v1.0

h2. API キーについて

{{thumbnail(1.png,size=320)}}

h3. API キーの作成

* 1. サービスにログインしている状態で、プロフィール画面( http://www.3dcg-arts.net/my/arts )にアクセスします。

* 2. API キー作成する場合は、「API キーを作成する」をクリックします。 キー作成する場合は、「*API キーを作成する*」をクリックします。

h3. API キーの削除

* 1. サービスにログインしている状態で、プロフィール画面( http://www.3dcg-arts.net/my/arts )にアクセスします。

* 2. API キー削除する場合は、「API キーを削除する」をクリックします。 キー削除する場合は、「*API キーを削除する*」をクリックします。

h3. API キーの取り扱い

* *API キーが他人に知られてしまった場合、あなたのアカウントで作品を投稿できてしまうため API キーは、他人に知られないように大切に保管してください。*

h2. 作品の取得

* HTTP メソッド
** GET
* HTTP パス
** http://api.3dcg-arts.net/api/v1/arts.json

h3. API 呼出

|{text-align:center}. 引数名|{text-align:center}. 値|
|{text-align:center}. ids|{text-align:center}. 作品番号(カンマ区切りにより複数指定可能です)|

h3. API 応答

h4. 失敗時

<pre>
{
"error_message": "[エラーメッセージ]",
"status": [レスポンスコード]
}
</pre>

h4. 成功時

<pre>
[
{
"id": [作品番号],
"title": "[作品名]",
"icon":
{
"128x128": "[128x128 サイズのアイコンパス]",
"256x256": "[256x256 サイズのアイコンパス]"
}
}
]
</pre>

h4. API サンプル

* HTTP メソッド
** GET
* HTTP パス
** http://api.3dcg-arts.net/api/v1/arts.json?ids=1

<pre>
[
{
"id": 1,
"title": "初音ミク・オン・ステージ",
"icon":
{
"128x128": "http://www.3dcg-arts.net/s3/art_icons/532/834d9539a9b9fae6acd9136e270b2e2ca94342e5e362c68018e97f543b150ab7/128x128.png",
"256x256": "http://www.3dcg-arts.net/s3/art_icons/532/e5c6e6d5513da17c9a608c5d61d7bb5f75b04612001dfc491b61b525150523dc/256x256.png"
}
}
]
</pre>

h2. 作品の投稿(API キー発行が必要です)

* HTTP メソッド
** POST
* HTTP パス
** http://api.3dcg-arts.net/api/v1/arts.json

h3. API 呼出

* 準備中

h3. API 応答

h4. 失敗時

<pre>
{
"error_message": "[エラーメッセージ]",
"status": [レスポンスコード]
}
</pre>

h4. 成功時

* 準備中