图片入库请求
图片入库请求是用于构建自己的图片库，该接口为异步接口，图片入库的状态可以通过接口返回的task_id查询接口 任务状态查询请求 获得
图片及接口的通用说明详见 服务概述
1). 接口地址
https://aiapi.jd.com/jdai/index
2). 请求方式
post
3). 接口数据要求
见概述
4). 请求参数
(1) query请求参数
公共请求参数
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| appkey | string | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey，可在买家中心控制台中获取 |
| timestamp | long | 是 | 1541491668060 | 请求的时间戳，精确到毫秒，timestamp有效期5分钟 |
| sign | string | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名，根据规则MD5(sectetkey+timestamp) |
(2) header请求参数
业务请求参数
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Content-Type | string | 是 | application/x-www-form-urlencoded | 编码格式 |
(3) body请求参数
业务请求参数
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| collection_name | string | 是 | "food" | 库名，每个用户最多创建3个图片库 |
| docs | array | 是 | [...] | 入库图片列表 |
docs参数信息
| 名称 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| image_name | string | 是 | "Milk_salt_soda_v1" | 图片名，作为图片的唯一标识 ，由用户自定义，用于后续查 询等操作，最大长度为50字 符，支持utf8编码； |
| image_content | string | 是 | "http://img10.360buyimg.com/ da/jfs/xxxxxxx.jpg" |
图片url或者base64编码(去掉图片头 "data:image/png;base64,")， url目前仅支持存储在JSF服务器 的图片链接；若有大规模图片 入库需求，请联系我们。 |
| info | string | 否 | "{\"Ingredients\":\"wheat flour, milkfat, edible salt\", \"price\":\"10.0\"}" |
图片的备注信息，最大长度 为300字符，如有提供，搜索时 将一并返回 |
返回参数
1). 公共返回参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | string | 1000 | 参见概述-系统级错误码 |
| charge | boolean | false 或 true | false：不扣费， true：扣费 |
| remainTimes | long | 1305 | 剩余调用次数；免费api：每天剩余调用次数；收费api：剩余次数；无限制时为-1 |
| remainSeconds | long | 1223456 | 剩余调用时间（s）；免费api：-1；收费api：剩余调用时间；无限制时为-1 |
| msg | string | 查询成功 | 参见概述-系统级错误码 |
| result | object | {...} | 查询结果 |
2). 业务返回参数
result参数信息
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| status_code | int | 0 | 参照概述-业务错误码 |
| message | string | "SUCCESS" | 参照概述-业务错误信息 |
| task_id | string | "92374205376234/food/1573113266.7619262" | 本次请求的任务id，可用于查询任务状态(包含后续流程中 待处理/处理成功/处理失败 的图片列表) |
| failed_list | array | [...] | 传入的docs中即时检查失败的doc列表(url或base64无效、info过长、图片名已存在库中等情况)，仅当status_code为0时存在 |
failed_list 参数信息
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| image_name | string | "DUPLICATE_EGG" | 图片名 |
| message | string | "REPEAT_IMAGE_NAME_IN_DB" | 即时检查的失败信息 |
3). 返回示例
Status Code: 200
Time：746ms
Date：Fri 15 Mar 2019 08:20:38 GMT
Body：
{
"code": "10000",
"charge": false,
"remainTimes": 4998,
"remainSeconds": -1,
"msg": "查询成功",
"result": {
"status_code": 0,
"message": "SUCCESS",
"task_id": "92374205376234/food/1573113266.7619262",
"failed_list": [
{
"image_name": "DUPLICATE_EGG",
"message": "REPEAT_IMAGE_NAME_IN_DB"
},
……
]
}
}