SDK使用说明接口规则.PDFVIP

SDK使用说明 通用错误码 返回码 返回信息 备注 200 -- 调用成功 450 -- 记录请求信息时发生错误,具体见返回信息 460 AppKey is null! 请求中appKey为空 461 Signature is null!请求中签名为空 462 Consumer inexistence!AppKey对应的合作方不存在 463 Unauthorized Consumer!未授权的合作方 464 Invalid Signature!签名不正确 465 Authentication Exception!权限验证异常，具体见异常信息 466 Parameters Convert Exception!参数转换异常，具体错误见异常信息 安全认证签名介绍 接口规则 传输方 为保证交易安全性，采用HTTPS传输 式 hostname：平台的IP地址或域名。 URL格 port：平台的web访问端口。 式 uri：API的uri，详见API的接口定义。 举例：8:443/artemis/api/xxxxx 提交方 采用POST方法提交 式 数据格 提交和返回数据都为JSON格式 式 字符编 统一采用UTF-8字符编码 码 安全认 提供了基于AK/SK的安全认证方案。只有认证通过，才能正常访问每一个API。 证 权限控 每一个API都需要被授权。调用未被授权的API会提示错误。 制 证书要 暂不需要 求 调用成 功 详见#DOC@返回值规则@# 判断逻 辑 返回值规则 对于API接口调用返回的结果统一采用json格式，内容字段采用驼峰式方法命名,返回的接口内容格式如下： code：业务错误码。调用成功时，返回code为“0”，当调用失败时，code为十六进制字符串错误码。查看每个API的错误码定义来判断错误类型。 msg：返回的错误信息，方便对接和调试，不能有堆栈信息 data：数据内容 返回的数据格式一般有如下几种： a) 只返回单条数据。示例1 b) 返回多条数据。示例2 c) 没有分页信息的列表查询格式。示例3： d) 若为图片数据，则直接返回二进制数据流。 e) 若状态码不为0，表示异常，则返回错误信息。示例4： 调用认证 安全认证签名介绍 本平台的接口调用安全认证方案，使用普遍被各大开放平台使用的ak/sk安全认证方案。调用 API 时，如果API需要安全认证，首先需要获取API的授权，得到 AppKey和AppSecret；其次，拼接签名字符串，将计算后的签名放在请求的 Header 传入，网关会通过对称计算签名来验证请求者的身份。 装了调用开放平台的API的方法，屏蔽了接口的安全认证限制带来的调用复杂性。调用者可下载直接使用，详见SDK下载。其他开发语言，则需要详细阅读以下 内容，自行实现安全认证签名工作 一、名词解释 Http Method http请求的方法，常用的方法有GET/POST/PUT/DELETE等。 请求 http请求中的头信息。 headers（Request Headers） header http请求路径，指域名/IP（端口号）之后的部分，如请求地址为 path 指请求地址中的参数，如请求地址为 query bodyForm 指POST请求中body中以键值对存在的参数。 AppKey/AppSecret 计算。 签名字符串 指待签名计算的字符串 签名 指签名计算的结果，为字符串 二、签名流程 用BASE64算法生成签名（签