Project

General

Profile

RestAPIv1 » History » Version 5

admin, 05/13/2014 05:28 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 5 admin
      {
35 5 admin
        "128x128": "[128x128 サイズのアイコンパス]",
36 5 admin
        "256x256": "[256x256 サイズのアイコンパス]"
37 5 admin
      }
38 5 admin
  }
39 5 admin
]
40 5 admin
</pre>
41 5 admin
42 4 admin
h2. 作品の投稿
43 2
44 4 admin
* HTTP メソッド
45 4 admin
** POST
46 2
* HTTP パス
47 4 admin
** http://api.3dcg-arts.net/api/v1/arts.json
48 2
49 2
h3. API 呼出
50 2
51 2
|キー|値|
52 2
|{text-align:center}. apikey|ハッシュ文字列|
53 4 admin
|{text-align:center}. content|base64 エンコードされた圧縮(zip)ファイルバイナリ文字列|
54 2
55 2
h3. API 応答
56 2
57 5 admin
h4. 失敗時
58 2
59 2
<pre>
60 4 admin
{ error_message: "[エラーメッセージ]", status: [HTTP レスポンスコード] }
61 2
</pre>
62 2
63 5 admin
h4. 成功時
64 2
65 2
<pre>
66 2
{ "url":"作品アドレス" }
67 2
</pre>