Project

General

Profile

RestAPIv1 » History » Version 15

admin, 05/13/2014 06:06 PM

1 12 admin
{{>toc}}
2 12 admin
3 2
h1. The 3DCGARTS REST API v1.0
4 2
5 13 admin
h2. API キーの発行について
6 13 admin
7 15 admin
* 準備中
8 13 admin
9 4 admin
h2. 作品の取得
10 2
11 4 admin
* HTTP メソッド
12 4 admin
** GET
13 4 admin
* HTTP パス
14 4 admin
** http://api.3dcg-arts.net/api/v1/arts.json
15 4 admin
16 4 admin
h3. API 呼出
17 4 admin
18 5 admin
|{text-align:center}. 引数名|{text-align:center}. 値|
19 5 admin
|{text-align:center}. ids|{text-align:center}. 作品番号(カンマ区切りにより複数指定可能です)|
20 4 admin
21 2
h3. API 応答
22 2
23 5 admin
h4. 失敗時
24 5 admin
25 5 admin
<pre>
26 5 admin
{
27 5 admin
  "error_message": "[エラーメッセージ]",
28 5 admin
  "status": [レスポンスコード]
29 5 admin
}
30 5 admin
</pre>
31 5 admin
32 5 admin
h4. 成功時
33 5 admin
34 5 admin
<pre>
35 5 admin
[
36 5 admin
  {
37 5 admin
    "id": [作品番号],
38 5 admin
    "title": "[作品名]",
39 5 admin
    "icon":
40 6 admin
    {
41 6 admin
      "128x128": "[128x128 サイズのアイコンパス]",
42 6 admin
      "256x256": "[256x256 サイズのアイコンパス]"
43 6 admin
    }
44 2
  }
45 2
]
46 2
</pre>
47 6 admin
48 8 admin
h4. API サンプル
49 6 admin
50 7 admin
* HTTP メソッド
51 7 admin
** GET
52 7 admin
* HTTP パス
53 7 admin
** http://api.3dcg-arts.net/api/v1/arts.json?ids=1
54 7 admin
55 6 admin
<pre>
56 6 admin
[
57 6 admin
  {
58 6 admin
    "id": 1,
59 6 admin
    "title": "初音ミク・オン・ステージ",
60 6 admin
    "icon":
61 6 admin
    {
62 6 admin
      "128x128": "http://www.3dcg-arts.net/s3/art_icons/532/834d9539a9b9fae6acd9136e270b2e2ca94342e5e362c68018e97f543b150ab7/128x128.png",
63 6 admin
      "256x256": "http://www.3dcg-arts.net/s3/art_icons/532/e5c6e6d5513da17c9a608c5d61d7bb5f75b04612001dfc491b61b525150523dc/256x256.png"
64 6 admin
    }
65 6 admin
  }
66 6 admin
]
67 6 admin
</pre>
68 5 admin
69 10 admin
h2. 作品の投稿(API キー発行が必要です)
70 2
71 4 admin
* HTTP メソッド
72 4 admin
** POST
73 2
* HTTP パス
74 4 admin
** http://api.3dcg-arts.net/api/v1/arts.json
75 2
76 2
h3. API 呼出
77 2
78 11 admin
* 準備中
79 2
80 2
h3. API 応答
81 2
82 5 admin
h4. 失敗時
83 2
84 2
<pre>
85 9 admin
{
86 9 admin
  "error_message": "[エラーメッセージ]",
87 9 admin
  "status": [レスポンスコード]
88 9 admin
}
89 2
</pre>
90 2
91 2
h4. 成功時
92 2
93 11 admin
* 準備中