Project

General

Profile

RestAPIv1 » History » Version 31

admin, 05/13/2014 08:20 PM

1 12 admin
{{>toc}}
2 12 admin
3 2
h1. The 3DCGARTS REST API v1.0
4 2
5 17 admin
h2. API キーについて
6 2
7 17 admin
{{thumbnail(1.png,size=320)}}
8 2
9 17 admin
h3. API キーの作成
10 17 admin
11 20 admin
* 1. サービスにログインしている状態で、プロフィール画面( http://www.3dcg-arts.net/my/arts )にアクセスします。
12 17 admin
13 21 admin
* 2. API キー作成する場合は、「API キーを作成する」をクリックします。
14 17 admin
15 17 admin
h3. API キーの削除
16 17 admin
17 20 admin
* 1. サービスにログインしている状態で、プロフィール画面( http://www.3dcg-arts.net/my/arts )にアクセスします。
18 17 admin
19 21 admin
* 2. API キー削除する場合は、「API キーを削除する」をクリックします。
20 17 admin
21 17 admin
h3. API キーの取り扱い
22 17 admin
23 27 admin
* *API キーが他人に知られてしまった場合、あなたのアカウントで作品を投稿できてしまうため、 API キーは他人に知られないように大切に保管してください。*
24 13 admin
25 26 admin
h2. 作品の取得
26 2
27 4 admin
* HTTP メソッド
28 4 admin
** GET
29 4 admin
* HTTP パス
30 4 admin
** http://api.3dcg-arts.net/api/v1/arts.json
31 4 admin
32 4 admin
h3. API 呼出
33 4 admin
34 24 admin
|{text-align:center}. 引数名|{text-align:center}. 説明|{text-align:center}. デフォルト|{text-align:center}. 指定の必須性|
35 24 admin
|{text-align:center}. ids|{text-align:center}. 作品番号(カンマ区切りにより複数指定可能です)|{text-align:center}. -|{text-align:center}. 必須|
36 4 admin
37 2
h3. API 応答
38 2
39 5 admin
h4. 失敗時
40 5 admin
41 5 admin
<pre>
42 5 admin
{
43 5 admin
  "error_message": "[エラーメッセージ]",
44 5 admin
  "status": [レスポンスコード]
45 5 admin
}
46 5 admin
</pre>
47 5 admin
48 5 admin
h4. 成功時
49 5 admin
50 5 admin
<pre>
51 5 admin
[
52 5 admin
  {
53 5 admin
    "id": [作品番号],
54 5 admin
    "title": "[作品名]",
55 5 admin
    "icon":
56 6 admin
    {
57 6 admin
      "128x128": "[128x128 サイズのアイコンパス]",
58 6 admin
      "256x256": "[256x256 サイズのアイコンパス]"
59 6 admin
    }
60 2
  }
61 2
]
62 2
</pre>
63 6 admin
64 8 admin
h4. API サンプル
65 6 admin
66 7 admin
* HTTP メソッド
67 7 admin
** GET
68 7 admin
* HTTP パス
69 7 admin
** http://api.3dcg-arts.net/api/v1/arts.json?ids=1
70 7 admin
71 6 admin
<pre>
72 6 admin
[
73 6 admin
  {
74 6 admin
    "id": 1,
75 6 admin
    "title": "初音ミク・オン・ステージ",
76 6 admin
    "icon":
77 6 admin
    {
78 6 admin
      "128x128": "http://www.3dcg-arts.net/s3/art_icons/532/834d9539a9b9fae6acd9136e270b2e2ca94342e5e362c68018e97f543b150ab7/128x128.png",
79 6 admin
      "256x256": "http://www.3dcg-arts.net/s3/art_icons/532/e5c6e6d5513da17c9a608c5d61d7bb5f75b04612001dfc491b61b525150523dc/256x256.png"
80 6 admin
    }
81 6 admin
  }
82 6 admin
]
83 6 admin
</pre>
84 5 admin
85 10 admin
h2. 作品の投稿(API キー発行が必要です)
86 2
87 4 admin
* HTTP メソッド
88 4 admin
** POST
89 2
* HTTP パス
90 31 admin
** http://api.3dcg-arts.net/api/v1/arts.json
91 2
92 2
h3. API 呼出
93 2
94 29 admin
|*引数名*|*引数値*|*説明*|*デフォルト*|*指定*|
95 29 admin
|secret_access_key|文字列(SHA-512)|API キー|-|必須|
96 2
|type|文字列|投稿形式|-|必須|
97 30 admin
|content0|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
98 30 admin
|content1|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
99 30 admin
|content2|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
100 30 admin
|content3|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
101 30 admin
|content4|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
102 30 admin
|content5|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
103 30 admin
|content6|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
104 30 admin
|content7|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
105 30 admin
|content8|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
106 30 admin
|content9|文字列|投稿データ(baes64 encode されたファイルバイナリ)|-|任意|
107 2
108 30 admin
* *"イメージ作品を投稿する場合の例":http://www.3dcg-arts.net/my/arts/new*
109 29 admin
** http://api.3dcg-arts.net/api/v1/arts.json?type=image
110 30 admin
* *"ポリゴン作品を投稿する場合の例":http://www.3dcg-arts.net/my/arts/new*
111 29 admin
** http://api.3dcg-arts.net/api/v1/arts.json?type=polygon
112 2
113 2
h3. API 応答
114 2
115 2
h4. 失敗時
116 2
117 9 admin
<pre>
118 9 admin
{
119 9 admin
  "error_message": "[エラーメッセージ]",
120 2
  "status": [レスポンスコード]
121 2
}
122 2
</pre>
123 2
124 2
h4. 成功時
125 11 admin
126 22 admin
* 準備中
127 22 admin
128 30 admin
h4. API サンプル(イメージ作品の投稿)
129 2
130 2
* HTTP メソッド
131 2
** POST
132 2
* HTTP パス
133 30 admin
** http://api.3dcg-arts.net/api/v1/arts.json?type=image
134 30 admin
135 30 admin
<pre>
136 30 admin
</pre>
137 30 admin
138 30 admin
h4. API サンプル(ポリゴン作品の投稿)
139 30 admin
140 30 admin
* HTTP メソッド
141 30 admin
** POST
142 30 admin
* HTTP パス
143 30 admin
** http://api.3dcg-arts.net/api/v1/arts.json?type=polygon
144 22 admin
145 22 admin
<pre>
146 22 admin
</pre>