二维码服务接口说明.docx

二维码服务接口说明二维码图片生成服务接口功能说明通过输入生成二维码的参数获取二维码图像文件。服务地址http://service_host/o2d/gen?data=dataappid=AppIDuserid=UserIDreqid=RequestIDtoken=Token请求方式通过HTTP协议的“GET”方法请求服务，输入参数使用“QueryString”传递。输入参数参数名称参数类型是否必须说明data字串是用于生成二维码的内容，可以是文本、网址等（必须进行URL编码）width数值否指明二维码图片像素尺寸大小（width X widh），默认值200。level字符否指明纠错级别：H、Q、M（默认）、Lmargin数值否二维码码元边距（留白）默认为1type字串否生成的图片类型：png（默认）、jpeg、gifappid字串是调用端应用标识userid字串否调用端的湖南中烟用户标识reqid字串是调用端请求标识token字串是调用端请求令牌：客户端的私钥对“reqid”进行RSA加密后进行URL安全的BASE64编码后的内容返回结果正常直接返回二维码图像文件字节。错误HTTP应答代码为“417”，应答内容返回{“error”:{“code:”:-1, “message”:”出错信息”}}请求示例http://service_host/o2d/gen?width=100data=http%3a%2f%2%2fnportalapp%2fwebportal%2fhnzy%2findex.portal对象资源标识二维码地址服务接口功能说明基于湖南中烟云管端的云服务与对象资源管理规范，根据客户端传入的对象视图实现地址返回湖南中烟信息资源对象的二维码唯一标识地址。服务地址http://service_host/o2d/getshort?target=URLappid=AppIDuserid=UserIDreqid=RequestIDtoken=Token请求方式通过HTTP协议的“GET”方法请求服务，输入参数使用“QueryString”传递。输入参数参数名称参数类型是否必须说明target字串是对象视图实现地址（必须进行URL编码）。name字串否对象实例名称class字串否对象分类名称endpoint数字否0:表示所有终端1:表示仅桌面端2:表示仅手机端默认为0anonymous布尔否true或false表示是否允许匿名访问。默认为false。appid字串是调用端应用标识userid字串否调用端的湖南中烟用户标识reqid字串是调用端请求标识token字串是调用端请求令牌：客户端的私钥对“reqid”进行RSA加密后进行URL安全的BASE64编码后的内容返回结果返回对象视图的二维码唯一标识地址。请求示例HTTP GET请求：http://service_host/o2d/getshort?target= http%3a%2f%2应答内容返回：/o2d/s/FNrU3i注：二维码标识地址前缀可能会根据最终部署而变更。对象标识二维码生成服务接口功能说明根据客户端传入的对象视图实现地址返回湖南中烟信息资源对象的二维码图片。此接口是“二维码图片生成”与“对象资源标识二维码地址”结合。服务地址http://service_host/o2d/getimg?target=URLappid=AppIDuserid=UserIDreqid=RequestIDtoken=Token请求方式通过HTTP协议的“GET”方法请求服务，输入参数使用“QueryString”传递。输入参数参数名称参数类型是否必须说明target字串是对象视图实现地址（必须进行URL编码）。width数值否指明二维码图片像素尺寸大小（width X widh），默认值200。level字符否指明纠错级别：H、Q、M（默认）、Lmargin数值否二维码码元边距（留白）默认为1type字串否生成的图片类型：png（默认）、jpeg、gifname字串否对象实例名称class字串否对象分类名称endpoint数字否0: 表示所有终端1: 表示仅桌面端2: 表示仅手机端默认为0anonymous布尔否true或false表示是否允许匿名访问。默认为false。appid字串是调用端应用标识userid字串否调用端的湖南中烟用户标识reqid字串是调用端请求标识token字串是调用端请求令牌：客户端的私钥对“reqid”进行RSA加密后进行URL安全的BASE64编码后的内容返回结果正常直接返回二维码图像文件字节。错误HTTP应答代码为“417”，应答内容返回{“error”:{“code:”:-1, “message”:”出错信息”}}请求示例HTTP GET请求：http