海商·开放平台
首页
文档中心
文档中心
API类目
签名算法
错误码
名词解释
Demo示例下载
API调用指南
开放平台(HOP)的API是基于HTTP协议来调用的,开发者(ISV)可以直接使用HOP提供的官方SDK(包含了请求的封装,签名加密,响应解释,性能优化等)来调用,也可以根据HOP的协议来封装HTTP请求进行调用,以下主要是针对自行封装HTTP请求进行API调用的原理进行详细解说。
API接口交互流程说明
根据HOP的协议:填充参数 > 生成签名 > 拼装HTTP请求 > 发起HTTP请求> 得到HTTP响应 > 解释json结果,以下是大体的调用过程示意图
公共参数
调用任何一个API都必须传入的参数,目前支持的公共参数有:
系统级别输入参数
名称
类型
是否必须
描述
app_key
String
是
HOP分配给应用的AppKey
timestamp
DateTime
是
时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。HiShop API服务端允许客户端请求最大时间误差为10分钟。
sign
String
是
API输入参数签名结果,签名算法参照
这里
的介绍。
业务参数
API调用除了必须包含公共参数外,如果API本身有业务级的参数也必须传入,每个API的业务级参数请考API文档说明。