创建码平台对外提供的常用二维码接口,不适于码平台业务类型的码创建,如不支持包裹码、媒体码等,业务类型的码需要单独提供API。
名称 | 类型 | 是否必须 | 示例值 | 更多限制 | 描述 |
---|---|---|---|---|---|
type | String | 必须 | url |
|
要制作的二维码业务类型:page:无线页面类型item:宝贝ID类型url:普通的URL连接类型shop:店铺ID类型 |
content | String | 必须 | 12345 |
|
二维码的内容之一,由type决定:type=page时,content传入无线页面的URL连接内容;type=item时,content传入宝贝数字ID;type=url时,content传入普通的URL连接内容;type=shop时,content传入店铺ID; |
name | String | 必须 | 淘小店的无线店铺首页 |
|
二维码名字,即创建的二维码,在码平台上显示记录的名字。 |
channel_name | String | 可选 | 杭州市区门店A |
|
二维码需要布点的位置,方便用户在码平台上可以区分看到不同布点的扫码数据情况;列表值,用半角','号分割,单个渠道名不能超过16字符。 |
style | String | 必须 | EF4F2B |
|
二维码的样式名,支持普通码的颜色或官方模板的模板名;普通码的颜色可选输入:“000000”(黑色)、“EF4F2B”(橙色);官方模板的可选输入(实际尺寸比样例大):“ww_color.png“ 尺寸290x320,样例:http://gtms03.alicdn.com/tps/i3/T1YLPRFRXXXXbsbYwb-100-102.png;“tb_scan.png“ 尺寸290x320,样例:http://gtms01.alicdn.com/tps/i1/T14vsEFThdXXbsbYwb-100-102.png;“ww_hide_color.png“ 尺寸200x263,样例:http://gtms04.alicdn.com/tps/i4/TB1URvlFVXXXXbRXFXXwxcf6pXX-76-100.png;“tmall_hide_color.png“ 尺寸200x263,样例:http://gtms01.alicdn.com/tps/i1/TB1S5PiFVXXXXacXVXXwxcf6pXX-76-100.png。 |
size | Number | 必须 | 175 | 二维码尺寸,只支持普通二维码,不支持官方模板,单位为像素,最小为60×60,最大为300×300,建议175×175。官方模板大小尺寸见style说明。 | |
need_eps | Boolean | 可选 | true |
|
是否需要矢量图,如果需要矢量图,设置为true;只支持普通二维码,官方模板不支持矢量图 |
logo | String | 可选 | http://img01.taobaocdn.com/imgextra/T1Od8YFT8eXXXXXXXX |
|
二维码的logo地址,只允许淘宝官方图片空间的图片地址,其他非图片空间图片不支持。官方淘logo图片地址:http://img01.taobaocdn.com/imgextra/T1Od8YFT8eXXXXXXXX。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
modules | QrcodeDO [] | 二维码对像 | |
|
|||
suc | Boolean | true | 执行是否成功 |
1 2 3 4 5 6 7 8 9 10 11 12 | TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret); MaQrcodeCommonCreateRequest req = new MaQrcodeCommonCreateRequest(); req.setType( "url" ); req.setContent( "12345" ); req.setName( "淘小店的无线店铺首页" ); req.setChannelName( "杭州市区门店A" ); req.setStyle( "EF4F2B" ); req.setSize(175L); req.setNeedEps( true ); MaQrcodeCommonCreateResponse rsp = client.execute(req, sessionKey); System.out.println(rsp.getBody()); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | < ma_qrcode_common_create_response > < modules > < qrcode_d_o > < channel_id >1234</ channel_id > < channel_name >淘小宝市区线下门店A</ channel_name > < qrcode_id >123</ qrcode_id > </ qrcode_d_o > </ modules > < suc >true</ suc > </ ma_qrcode_common_create_response > |
1 2 3 4 5 6 | < error_response > < code >50</ code > < msg >Remote service error</ msg > < sub_code >isv.invalid-parameter</ sub_code > < sub_msg >非法参数</ sub_msg > </ error_response > |
错误码 | 错误描述 | 解决方案 |
---|---|---|
isv.service-is-error | 远程服务错误 | 调整参数重试,确有问题请联系淘宝相应开发小二 |
isv.invalid-permission | 权限不对,或者登录超时 | 检查权限、登录是否超时 |
isv.invalid-parameter-type | 入参type值不对,只允许文档穷举值 | 请参照文档提供值 |
isv.invalid-parameter-content | 输入的content内容非法 | 宝贝或店铺ID只允许输入数字,URL只允许阿里域下面的连接 |
isv.invalid-parameter-name | 输入的二维码名字为空或者超出32字符长度限制 | 按文档要求修改参数值 |
isv.invalid-parameter-channel-name | 渠道名列表个数超出10个或者单个渠道名超出16字符长度 | 修改渠道名参数值 |
isv.invalid-parameter-style | 二维码样式值不对,只允许文档提供的可选值 | 按照文档提供的值修改 |
isv.invalid-parameter-size | 二维码尺寸不对 | 二维码大小只允许60~300间,建议使用175相素尺寸 |
isv.invalid-parameter-logo | 二维码logo只允许淘宝图片空间图片,且未被删除 | 使用淘宝图片空间图片,有对应的API可以上传或获取 |