Project

General

Profile

RestAPIv1 » History » Version 50

« Previous - Version 50/100 (diff) - Next » - Current version
admin, 05/14/2014 10:45 PM


The 3DCGARTS REST API v1.0

API キーについて

1.png

API キーの作成

  • 2. API キー作成する場合は、「API キーを作成する」をクリックします。

API キーの削除

  • 2. API キー削除する場合は、「API キーを削除する」をクリックします。

API キーの取り扱い

  • API キーが他人に知られてしまった場合、あなたのアカウントで作品を投稿できてしまうため、 API キーは他人に知られないように大切に保管してください。

HTTP ステータスコード(HTTP レスポンスコード)

コード 説明
200 正常に処理されました(詳細はこちら)。
304 正常に処理されました(詳細はこちら)。
400 引数の内容に問題があります。
403 引数の内容に問題があります(API キーが発行されていない or アクセス権限が存在しない)。
500 作品投稿時の変換エラーが発生。あるいは、不明なエラーにより正常に処理することができませんでした。

作品の取得

API 呼出

引数名 引数値 説明 デフォルト 指定
ids 文字列 作品番号(カンマ区切りにより複数指定可能です) - 必須

API 応答

失敗時

{
  "error_message": "[エラーメッセージ]" 
}

成功時

[
  {
    "id": "[作品番号]",
    "title": "[作品名]",
    "icon":
    {
      "128x128": "[128x128 サイズのアイコンパス]",
      "256x256": "[256x256 サイズのアイコンパス]" 
    }
  }
]

API サンプル

[
  {
    "id": 1,
    "title": "初音ミク・オン・ステージ",
    "icon":
    {
      "128x128": "http://www.3dcg-arts.net/s3/art_icons/532/834d9539a9b9fae6acd9136e270b2e2ca94342e5e362c68018e97f543b150ab7/128x128.png",
      "256x256": "http://www.3dcg-arts.net/s3/art_icons/532/e5c6e6d5513da17c9a608c5d61d7bb5f75b04612001dfc491b61b525150523dc/256x256.png" 
    }
  }
]

作品の投稿(API キー発行が必要です)

API 呼出

引数名 引数値 説明 デフォルト 指定
secret_access_key 文字列(SHA-512) API キー - 必須
type 文字列 投稿形式 - 必須
content[data]0 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 必須
content[type]0 文字列 投稿データの拡張子 - 必須
content[data]1 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]1 文字列 投稿データの拡張子 - 任意(content1[data] が指定されている場合、必須)
content[data]2 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]2 文字列 投稿データの拡張子 - 任意(content2[data] が指定されている場合、必須)
content[data]3 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]3 文字列 投稿データの拡張子 - 任意(content3[data] が指定されている場合、必須)
content[data]4 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]4 文字列 投稿データの拡張子 - 任意(content4[data] が指定されている場合、必須)
content[data]5 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]5 文字列 投稿データの拡張子 - 任意(content5[data] が指定されている場合、必須)
content[data]6 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]6 文字列 投稿データの拡張子 - 任意(content6[data] が指定されている場合、必須)
content[data]7 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]7 文字列 投稿データの拡張子 - 任意(content7[data] が指定されている場合、必須)
content[data]8 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]8 文字列 投稿データの拡張子 - 任意(content8[data] が指定されている場合、必須)
content[data]9 文字列 投稿データ(baes64 encode されたファイルバイナリ) - 任意
content[type]9 文字列 投稿データの拡張子 - 任意(content9[data] が指定されている場合、必須)
  • 投稿データについて
    • 投稿データは base64 encode された「ポリゴンファイル」「テクスチャファイル」「マテリアルファイル」の文字列を指定するか、
      各ファイルをまとめた ZIP ファイル(圧縮ファイル)のバイナリを base64 encode した文字列を指定してください(投稿形式の詳細はこちら)。

API 応答

失敗時

{
  "error_message": "[エラーメッセージ]" 
}

作品投稿時エラー時のHTTPのステータスコードは以下のとおりとなります。

  • 400,403
    • 引数に問題がある場合
  • 500
    • 作品データの変換に失敗した場合

成功時

{
  "edit_my_arts_path": "[投稿作品の編集ページ]" 
}

API サンプル(イメージ作品の投稿)

{
  "edit_my_arts_path": "http://www.3dcg-arts.net/my/arts/1/edit" 
}

API サンプル(ポリゴン作品の投稿)

{
  "edit_my_arts_path": "http://www.3dcg-arts.net/my/arts/1/edit" 
}