Project

General

Profile

RestAPIv1 » History » Version 8

admin, 05/13/2014 05:35 PM

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