images¶

images/では、画像一覧の取得や登録ができます。

エンドポイント	説明
GET /images	アップロードした画像一覧の取得
GET /images/:id	指定した id に該当する画像情報の取得
POST /images	画像の登録

Important

リクエストする際には各種エンドポイントの末尾に / を付与してリクエストしてください。具体的には、/images/123 というURLに対するリクエストは /images/123/ としてリクエストをします。

GET /images¶

これまでにアップロードした画像ファイルの一覧情報を取得できます。

リクエスト¶

HTTPリクエスト¶

1	`GET https://api.customer.jp/anymotion/v1/images/`

リクエストヘッダー¶

リクエストヘッダー	説明
Authorization	Bearer `<アクセストークン>`

リクエストパラメータ¶

パラメータ	説明	必須
page	ページ番号	-
size	ページサイズ	-

レスポンス¶

レスポンスボディ¶

プロパティ	タイプ	説明
next	String	次ページのURL
previous	String	前ページのURL
maxPage	integer	最大ページ番号
data	String	データ一覧
data[].id	integer	画像 ID
data[].name	String	画像の名前
data[].createdAt	String	作成時刻
data[].updatedAt	String	更新時刻

サンプルレスポンス¶

{
  "next": null,
  "previous": null,
  "maxPage": 1,
  "data": [
    {
      "id": 10,
      "name": "画像名",
      "createdAt": "2020-01-09T06:48:50.340529Z",
      "updatedAt": "2020-01-09T06:48:50.340568Z"
    },
    {
      "id": 9,
      "name": "画像名",
      "createdAt": "2020-01-09T06:48:50.340529Z",
      "updatedAt": "2020-01-09T06:48:50.340568Z"
    },
    ...
  ]
}

GET /images/:id¶

画像の詳細情報を取得します。

リクエスト¶

HTTPリクエスト¶

1	`GET https://api.customer.jp/anymotion/v1/images/:id/`

リクエストヘッダー¶

リクエストヘッダー	説明
Authorization	Bearer `<アクセストークン>`

リクエストパラメータ¶

パラメータ	説明	必須
id	画像 ID	●

レスポンス¶

プロパティ	タイプ	説明
id	Integer	画像 ID
name	String	画像の名前
height	Integer	画像の高さ
width	Integer	画像の幅
text	String	画像の説明文
contentMd5	String	ファイルの MD5 値
createAt	String	作成時刻
updateAt	String	更新時刻

レスポンスボディ¶

{
  "id": 1,
  "name": "画像名",
  "height": 300,
  "width": 480,
  "text": "画像の説明文",
  "contentMd5": "ecWkdCSrnAa9+EYREt/fbg==",
  "createdAt": "2018-10-29T05:34:03.009965Z",
  "updatedAt": "2018-10-29T05:34:03.010018Z"
}

POST /images¶

画像情報を登録します。

リクエスト¶

HTTPリクエスト¶

1	`POST https://api.customer.jp/anymotion/v1/images/`

リクエストヘッダー¶

リクエストヘッダー	説明
Authorization	Bearer `<アクセストークン>`
Content-Type	application/json

リクエストボディ¶

フィールド	タイプ	説明	必須
name	String	画像の名前	-
text	String	画像の説明文	-
contentMd5	String	ファイルの MD5 値	●

サンプルリクエスト¶

{
  "name": "baseball.jpg",
  "text": "画像の説明",
  "contentMd5": "ecWkdCSrnAa9+EYREt/fbg=="
}

レスポンス¶

レスポンスボディ¶

プロパティ	タイプ	説明
id	Integer	画像 ID
uploadUrl	String	アップロード URL
name	String	画像の名前
text	String	画像の説明文
contentMd5	String	ファイルの MD5 値
createAt	String	作成時刻
updateAt	String	更新時刻

Hint

レスポンスとして得られるuploadUrlに対して画像をアップロードしてください。

サンプルレスポンス¶

{
  "id": 36,
  "uploadUrl": "https://example.com",
  "name": "baseball.jpg",
  "text": "動画の説明文",
  "contentMd5": "ecWkdCSrnAa9+EYREt/fbg==",
  "createdAt": "2019-06-18T08:09:35.169278Z",
  "updatedAt": "2019-06-18T08:09:35.169335Z"
}