接口说明合集
请求说明
请求域名:
测试:https://opapi.yunbuye.cn/factory
- 平台开放key
"70EFDF2EC9B086079795C442636B55FB";
- 平台对接密钥
"F7177163C833DFF4B38FC8D2872F1EC6";
- 染厂对接授权码
"5C9BE81AD6CD35C7357670E747BF9273";
请求方式:
- post
请求header设置:
参数 | 说明 |
---|---|
Content-Type | 默认 application/json |
Content-Length | 必填 |
x-yby-openKey | 平台开放key |
x-yby-sign | 生成签名(字母不需要转大写) |
x-yby-timestamp | 当前时间戳 |
x-yby-ia-code | 染厂对接授权码 |
签名生成方法
1、请求参数json, 密钥,当前时间戳用“&”连接起来生成字符串
var sign = post_data + '&' + secretKey + '&'+ timestamp
2、md5加密
sign = CryptoJS.MD5(sign).toString();
3、拼接一个6位随机字符
sign = sign + randomStr(6);
错误状态码说明
错误码code | 备注 |
---|---|
0 | 请求成功 |
10001 | 公司信息不正确 |
10002 | secret信息为配置 |
10003 | 解密失败时 |
10004 | 未知错误,请看msg |
400 | 接口异常提示 |
412 | 参数异常提示 |
422 | 表单校验错误 |
500 | 其他错误 |
1、获取加工订单信息
请求URL:
{域名}/api/process/yby/get-order-by-dye-finished
请求方式:
- post
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
jg_dh | 是 | string | 单号 |
请求示例
{ "jg_dh":"JGD2108190001" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
返回示例
{ "code": 0, "msg": "请求成功", "data": { "id": 105, //单据id "dh": "JGD2108190001", //单据单号 "kdsj": "2021-08-19 09:03:00", //开单时间 "jl": [ //记录 { "id": 120, //记录id "ps": 10, //匹数 "zsl": 100,//数量 "fzbh": "",//产品-辅助编号 "fzmc": "",//产品-辅助名称 "fzsh": "",//颜色-辅助色号 "fzys": "",//颜色-辅助颜色 "gh": "10",//缸号 "ph": "",//批号 "jh": "",//卷号 "fk": "aa",//幅宽 "kz": "cc",//克重 "gg": "",//规格 "dw_id": 1,//单位id "ck_zdy1": "",//仓库自定义字段 "ck_zdy2": "",//仓库自定义字段 "ck_zdy3": "",//仓库自定义字段 "ck_zdy4": "",//仓库自定义字段 "ck_zdy5": "",//仓库自定义字段 "qtyq": [ //染整要求 "洗水牢度 : 二级;", "染整工艺 : 染整;" ], "hq": null,//货期 "cf": "",//成分 "jjcd": "0",//紧急程度 "kcms": "+",//空差模式 "kc": 0,//空差 "bz": "25555",//记录备注 "cp_mc": "LSP",//产品名称 "cp_bh": "001",//产品编号 "cp_ys_mc": "",//颜色名称 "cp_ys_bh": "@2",//色号 "dw_mc": "米"//单位名称 "cp_qm": "001", //产品名称(根据配置读取) "cp_ys_qm": "@2", //颜色名称 (根据配置读取) } ] } }
2、生成染厂完成记录
请求URL:
http://{域名}/api/process/yby/create-dye-finished-record
请求方式:
- post
参数:
- 根据 ERP档案 染厂二维码设置读取必传参数,可为空字符串,建议所有参数都赋值,方便布行ERP配置调整时不需要再调试。
参数名 | 必选 |
类型 | 说明 |
---|---|---|---|
bp_tm | 是 | string | 染厂布匹条码 (染厂自定义条码信息,需要唯一) |
cp_bh | 是 | string | 产品信息(记录信息的cp_qm) |
cp_ys_bh | 是 | string | 产品颜色信息(记录信息的cp_ys_qm) |
sl | 是 | double | 数量 |
jg_dh | 否 | string | 加工单号 |
jl_id | 否 | string | 记录ID |
gh | 否 | string | 缸号 |
jh | 否 | string | 卷号 |
fk | 否 | string | 幅宽 |
kz | 否 | string | 克重 |
only | 否 | string | 唯一值 (染厂自定义的唯一值) |
ck_zdy1 | 否 | string | 自定义仓库1 |
ck_zdy2 | 否 | string | 自定义仓库2 |
ck_zdy3 | 否 | string | 自定义仓库3 |
ck_zdy4 | 否 | string | 自定义仓库4 |
ck_zdy5 | 否 | string | 自定义仓库5 |
mx_ph | 否 | string | 明细匹号 每张单据从1开始自增 |
请求示例
{ "bp_tm": "354651321321", "jg_dh": "JGD2109090001", "jl_id": 8, "ps": 1, "sl": 10, "gh": "", "ph": "", "jh": "", "fk": "", "kz": "", "gg": "", "dw_id": 1, "ck_zdy1": "", "ck_zdy2": "", "ck_zdy3": "", "ck_zdy4": "", "ck_zdy5": "", "cp_bh": "003", "cp_ys_bh": "1#", "only": "3311", "mx_ph":"222" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
data.tm | string | ERP生成对应的条码 |
返回示例
{ "code": 0, "msg": "请求成功", "data": { "tm": "210908000101" } }
3、作废染厂完成记录
请求URL:
{域名}/api/process/yby/create-dye-finished-record
请求方式:
- post
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
tm | 是 | string | ERP条码信息 |
请求示例
{ "tm":"210908000100" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
返回示例
{ "code": 0, "msg": "请求成功", "data": [] }
- 更多返回错误代码请看首页的错误代码描述
染厂对接说明
请求说明
请求域名:
测试:http://gd932kj.gnway.org:7680/unified-order
请求方式:
- post
请求header设置:
参数 | 说明 |
---|---|
Content-Type | 默认 application/json |
Content-Length | 必填 |
x-yby-openKey | 平台开放key |
x-yby-sign | 生成签名(字母不需要转大写) |
x-yby-timestamp | 当前时间戳 |
x-yby-ia-code | 染厂对接授权码 |
签名生成方法
1、请求参数json, 密钥,当前时间戳用“&”连接起来生成字符串
var sign = post_data + '&' + secretKey + '&'+ timestamp
2、md5加密
sign = CryptoJS.MD5(sign).toString();
3、拼接一个6位随机字符
sign = sign + randomStr(6);
错误状态码说明
错误码code | 备注 |
---|---|
0 | 请求成功 |
10001 | 公司信息不正确 |
10002 | secret信息为配置 |
10003 | 解密失败时 |
10004 | 未知错误,请看msg |
400 | 接口异常提示 |
412 | 参数异常提示 |
422 | 表单校验错误 |
500 | 其他错误 |
获取加工订单信息
简要描述:
- 获取加工订单信息
请求URL:
http://xxxxx.cn/api/process/yby/get-order-by-dye-finished
请求方式:
- post
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
jg_dh | 是 | string | 单号 |
请求示例
{ "jg_dh":"JGD2108190001" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
返回示例
{ "code": 0, "msg": "请求成功", "data": { "id": 105, //单据id "dh": "JGD2108190001", //单据单号 "kdsj": "2021-08-19 09:03:00", //开单时间 "jl": [ //记录 { "id": 120, //记录id "ps": 10, //匹数 "zsl": 100,//数量 "fzbh": "",//产品-辅助编号 "fzmc": "",//产品-辅助名称 "fzsh": "",//颜色-辅助色号 "fzys": "",//颜色-辅助颜色 "gh": "10",//缸号 "ph": "",//批号 "jh": "",//卷号 "fk": "aa",//幅宽 "kz": "cc",//克重 "gg": "",//规格 "dw_id": 1,//单位id "ck_zdy1": "",//仓库自定义字段 "ck_zdy2": "",//仓库自定义字段 "ck_zdy3": "",//仓库自定义字段 "ck_zdy4": "",//仓库自定义字段 "ck_zdy5": "",//仓库自定义字段 "qtyq": [ //染整要求 "洗水牢度 : 二级;", "染整工艺 : 染整;" ], "hq": null,//货期 "cf": "",//成分 "jjcd": "0",//紧急程度 "kcms": "+",//空差模式 "kc": 0,//空差 "bz": "25555",//记录备注 "cp_mc": "LSP",//产品名称 "cp_bh": "001",//产品编号 "cp_ys_mc": "",//颜色名称 "cp_ys_bh": "@2",//色号 "dw_mc": "米"//单位名称 } ] } }
- 更多返回错误代码请看首页的错误代码描述
生成染厂完成记录
简要描述:
- 生成染厂完成记录
请求URL:
http://xxxxx.cn/api/process/yby/create-dye-finished-record
请求方式:
- post
参数:
- 根据 ERP档案 染厂二维码设置提供参数,必传,可为空字符串。
参数名 | 必选 |
类型 | 说明 |
---|---|---|---|
bp_tm | 是 | string | 染厂布匹条码 (染厂自定义条码信息,需要唯一) |
cp_bh | 是 | string | 产品信息(记录信息的cp_qm) |
cp_ys_bh | 是 | string | 产品颜色信息(记录信息的cp_ys_qm) |
sl | 是 | double | 数量 |
jg_dh | 否 | string | 加工单号 |
jl_id | 否 | string | 记录ID |
gh | 否 | string | 缸号 |
jh | 否 | string | 卷号 |
fk | 否 | string | 幅宽 |
kz | 否 | string | 克重 |
only | 否 | string | 唯一值 (染厂自定义的唯一值) |
ck_zdy1 | 否 | string | 自定义仓库1 |
ck_zdy2 | 否 | string | 自定义仓库2 |
ck_zdy3 | 否 | string | 自定义仓库3 |
ck_zdy4 | 否 | string | 自定义仓库4 |
ck_zdy5 | 否 | string | 自定义仓库5 |
mx_ph | 否 | string | 明细匹号 |
请求示例
{ "bp_tm": "354651321321", "jg_dh": "JGD2109090001", "jl_id": 8, "ps": 1, "sl": 10, "gh": "", "ph": "", "jh": "", "fk": "", "kz": "", "gg": "", "dw_id": 1, "ck_zdy1": "", "ck_zdy2": "", "ck_zdy3": "", "ck_zdy4": "", "ck_zdy5": "", "cp_bh": "003", "cp_ys_bh": "1#", "only": "3311", "mx_ph":"222" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
data.tm | string | ERP生成对应的条码 |
返回示例
{ "code": 0, "msg": "请求成功", "data": { "tm": "210908000101" } }
- 更多返回错误代码请看首页的错误代码描述
作废染厂完成记录
简要描述:
- 作废染厂完成记录
请求URL:
http://xxxxx.cn/api/process/yby/create-dye-finished-record
请求方式:
- post
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
tm | 是 | string | ERP条码信息 |
请求示例
{ "tm":"210908000100" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
返回示例
{ "code": 0, "msg": "请求成功", "data": [] }
- 更多返回错误代码请看首页的错误代码描述
染厂进度同步
简要描述:
- 染厂进度同步
请求URL:
{域名}/api/process/yby/sync-order-by-process
请求方式:
- post
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
list | 是 | string | 同步列表 |
list.jl_id | 否 | string | 记录ID(拆缸记录可不传) |
list.jg_dh | 是 | string | 加工单号 |
list.cp | 是 | string | 产品名称 |
list.cp_ys | 是 | string | 颜色 |
list.ps | 是 | string | 匹数 |
list.zsl | 是 | string | 数量 |
list.gh | 是 | string | 缸号 |
list.zt | 是 | string | 状态 |
list.zt_bz | 是 | string | 状态备注 |
请求示例
{ "list":[ { "jl_id": "", "jg_dh": "JGD2209030001", "cp": "003", "cp_ys": "有色系", "ps": "1", "zsl": "100", "gh": "79986", "zt": "111", "zt_bz": "222", } ] }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数(配置、参数异常则不返回) |
data.err_list | array | 同步异常提示 |
data.err_num | int | 异常记录数 |
data.new_num | int | 成功记录数 |
data.data | array | 返回请求单号所有记录行对应信息(加工单号、记录ID、缸号、批号) |
返回示例
{ "code": 0, "msg": "请求成功", "data": { "err_list": [], "err_num": 0, "new_num": 1, "data": [ { "jg_dh": "JGD2209030001", "jl_id": 342, "gh": "", "ph": "" }, { "jg_dh": "JGD2209030001", "jl_id": 360, "gh": "79986", "ph": "" } ] } } //参数配置异常提示 { "code": 422, "msg": "参数非法:list第1行 zsl" } //同步异常提示 { "code": 400, "msg": "保存失败", "data": { "err_list": [ "记录第 1 行 产品: 在单据中不存在相同产品", "记录第 1 行 无效的颜色: 有色系" ], "err_num": 0, "new_num": 0, "data": [] } }
- 更多返回错误代码请看首页的错误代码描述
获取加工订单列表
简要描述:
- 获取加工订单列表
请求URL:
{域名}/api/process/yby/get-order-list
请求方式:
- post
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
page | 是 | int | 页码 |
start_time | 是 | date | 开始日期 |
end_time | 是 | date | 结束日期 |
jg_dh | 否 | string | 加工单号 |
请求示例
//前后时间与当前时间不能相隔超过一个月 { "start_time": "2023-03-14", "end_time": "2023-04-30", "page": 1, "jg_dh": "JGD2303230002" }
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 响应信息 |
data | obj | 返回参数 |
data.data | array | 单据列表 |
data.current_page | int | 当前页码 |
data.total | int | 总条数 |
data.total_page | int | 总页数 |
返回示例
{ "code": 0, "msg": "请求成功", "data": { "data": [ { "id": 306, "dh": "JGD2303230002", "kdsj": "2023-03-23 11:17:00", "jl": [ { "id": "385", "ps": 1, "zsl": 1, "fzbh": "", "fzmc": "", "fzsh": "", "fzys": "", "gh": "", "ph": "", "jh": "", "fk": "", "kz": "", "gg": "", "dw_id": "", "ck_zdy1": "", "ck_zdy2": "", "ck_zdy3": "", "ck_zdy4": "", "ck_zdy5": "", "qtyq": [], "hq": null, "cf": "", "jjcd": "0", "kcms": "+", "kc": 0, "bz": "", "cp_mc": "", "cp_bh": "000奥迪A6", "cp_ys_mc": "", "cp_ys_bh": "白坯#", "cp_qm": "000奥迪A6", "cp_ys_qm": "白坯#", "dw_mc": "米" } ] } ], "current_page": 1, "total": 1, "total_page": 1 } }
- 更多返回错误代码请看首页的错误代码描述