第三方登录
QQ登录 微信登录
排版就来 时代定制是国内领先的协作排版系统

常用API接口列表说明

2018-11-30 09:12:00

1.作品信息(设计稿)获取接口

请求方式:后台post请求

请求网址://www.sddiy./api/oworkfile.asmx/getWorkInfo

请求参数:app_idwork_info

请求示例:

$.post('https://www.sddiy.cn/api/oworkfile.asmx/getWorkInfo',{app_id:'您的APP_ID',work_info:encodeURIComponent('DES3加密后的work_info')},function(msg){console.log(msg);});

该示例在浏览器console中执行js,如下图所示。也可以在php、c#等语言中执行(注意work_info须urlencode后再传入)。

返回数据(格式):

{"name":"作品名称","remark":"全稿备注^^第1版气泡1^气泡2^^第二版气泡1","count":"版面数量","page":[{"diag":"缩略图文件名","sizes":"规格名","more":[更多参数json值]},{"diag":"缩略图文件名","sizes":"规格名","more":[{"n":"工艺","v":"烫金"},{"n":"材质","v":"123.jpg"}]}],"photo":[{"a":"相册ID","c":调用次数,"w":"宽","h":"高","p":"出现的版面序号","src":"图片文件名","t":"摄影时间"},{"a":"相册ID","c":调用次数,"w":"宽","h":"高","p":"所在版面1序号,所在版面2序号","src":"图片文件名","t":""}]}

返回的内容包含了稿件的名称、全稿备注、每个版面的气泡内容、版面的数量、每个版面的缩略图文件名和版面的规格名称、更多参数、稿件引用的图片信息。其中“更多参数”内容请进入“工作台”——>“规格”设置。

错误信息:0 失败(APP_ID不存在或程序报错), -1 API尚未开启, -2 请求域名不合法, -3 作品图片不存在, -4 该作品不属于当前企业账户或者作品不存在, -5 参数格式错误, -6 票据失效或作品id空

注意:请求参数“work_info” 的内容格式:时间戳[y-m-d h:i:s] | 作品ID,包含两个参数。一个为发起请求时的时间,一个为作品的ID(非GUID)。work_info须经加密后传入,加密方式参考API账号对接示例https://www.sddiy.cn/helpArticle?Id=888。你也可以直接通过【调试工具】生成work_info,快速进行测试。如果返回错误信息,请先解码work_info并确认其数据格式正确。

 

2.作品照片获取接口

请求方式:后台post请求

请求网址://www.sddiy.cn/api/oworkphoto.asmx/getWorkPhoto

请求参数:app_id,  work_info

注意:参数“work_info” 的内容为:时间戳[y-m-d h:i:s]|作品ID生成方法参看第一个接口介绍


3.相册照片获取接口

请求方式:后台post请求

请求网址://www.sddiy.cn/api/oworkphoto.asmx/getAlbumPhoto

请求参数:app_id,  work_info

注意:参数“work_info” 的内容为:时间戳[y-m-d h:i:s]|作品ID生成方法参看第一个接口介绍


4.作品出图请求接口

请求方式:后台post请求

请求网址://www.sddiy.cn/api/oworkfile.asmx/getWorkPrinting

请求参数:app_id,  work_info

返回值: 两位浮点数 表示预计出图完成的消耗时长(单位为分钟)
                     -2 表示接口请求意外错误,需技术客服排查原因。
                     -3 表示该作品不属于API商家,无权请求。
                     多位正整数(作品ID)表示作品不存在。
                     -6 表示票据超时

注意:参数“work_info” 的内容为:时间戳[y-m-d h:i:s]|作品ID|图稿文件格式生成方法参看第一个接口介绍。其中图稿文件格式值定义:0:jpg格式,1:pdf格式。可不传图稿文件格式,即格式为时间戳|作品ID”,则默认为JPG格式。

注意:通过API接口申请出图后,则下载时也需要通过API下载(即下方接口5)。因为API出图的场景下,生成的图稿文件名称和网页端出图部分情况不一样,若API出图后再在网页端下载 则可能获取不到文件。


5.出图稿件获取接口

请求方式:后台post请求

请求网址://www.sddiy.cn/api/oworkfile.asmx/getWorkFile

请求参数:app_idwork_info

返回数据格式: {"url":"https://img.sddiy.cn/图片资源链接目录","list":"版面1资源文件名称$存在否标志,版面2资源文件名称$存在否标志"}

返回错误码: -3 表示作品不存在, -4 表示作品不属于API商家 或 稿件不存在, -6 表示票据超时。

说明:上方返回数据 url为版面资源文件所在目录,list表示所有版面对应的图稿名称,多个版面通过半角逗号分隔,另外,“版面1资源文件名称$存在否标志” 为文件名称、文件存在标志用 $ 符号分隔,文件存在时则该值为1,不存在则为0。

注意:参数“work_info” 的内容为:时间戳[y-m-d h:i:s]|作品ID|图稿文件格式生成方法参看第一个接口介绍。其中图稿文件格式值定义:0:jpg格式,1:pdf格式。可不传图稿文件格式,即格式为时间戳|作品ID”,则默认为JPG格式。

获取到稿件信息后,可以在前端直接下载,示例如下:window.open('https://www.sddiy.cn/ajaxPage/downloadAjax.ashx?n=《稿件压缩包名称》&p=&e=jpg&m=&i=8888&ft=work&t=downloadworks')
       其中参数e为下载的类型,若出图pdf则此处应填写pdf;i为作品ID

 

    6.出图信息同步接口

请求方式:后台post请求(由平台向订单回调路径请求)

使用场景:平台出图后,给订单回调链接发送同步出图信息请求;

请求参数:method"send_print_result",  work_id作品ID,  status出图状态(0失败,1成功),  plist版面列表,  pageUrl出图稿件地址

返回数据:{data预计等待分钟时长,  data2""} 

错误信息:0 失败, -1 API尚未开启, -2 请求域名不合法, -3作品图片不存在, -4该作品不属于当前企业账户或者作品不存在,   -5参数格式错误, -6 票据失效

 

7.扫码发货同步订单接口

请求方式:后台post请求

使用场景:平台扫码发货后,给订单回调链接发送同步订单信息请求;

请求参数:action"setshipping",  setshipping"do",  work_id作品ID(非32位的GUID),  shipping_num物流单号,  order_status:  订单状态(已发货 = 10)

 

8.上传照片到用户相册接口

请求方式:后台post请求或者前台表单提交均可

请求网址://www.sddiy.cn/ajaxpage/oPhotoUpload.ashx

参数:guid用户guid,method0为后台传输 / 1为表单提交,  albumList相册ID(默认0,即默认文件夹),  app_keyAPP_KEY, pp_idAPP_ID,  Filedata文件内容

说明:当用户登录时,照片上传到当前用户的图片文件夹(即相册)

 

9.订单信息获取接口

请求方式:后台post请求

请求网址://www.sddiy.cn/api/oOrder.asmx/getOrder

请求参数:app_id,  work_info

注意:参数“work_info” 的内容为:时间戳[y-m-d h:i:s]|作品ID,  作品ID为订单关联的作品,生成方法参看第一个接口介绍。

 

10.订单信息同步接口

请求方式:后台post请求

请求网址://www.sddiy.cn/api/oOrder.asmx/setOrder

请求参数:app_id,  work_info

注意:请求参数work_info内容格式为:时间戳[y-m-d h:i:s]| work_id | 订单状态 | 物流单号 | 收货人姓名 | 收货人电话 | 收货地址|下单时间|支付时间|发货时间,橙色部分可以不填。work_info加密生成方法参看第一个接口介绍。


11.商家派单通知接口

请求方式:后台post请求

使用场景:平台商家派单后,给代工厂回调链接发送通知请求;

请求参数:action:"orderDispach",  order_id订单id,  work_id作品id, work_name作品名,order_from派单商家名,  dispach_time派单时间,  order_detail订单详情,  order_remark:  订单备注

 

重点提示:若是在chrome80以上版本浏览器(如谷歌新版、360新版)内访问,需要将 http 改为 https,否则无法跨域,将会访问失败。