Project

General

Profile

RestAPIv1 » History » Version 12

admin, 05/13/2014 05:44 PM

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