沃土开放平台

API文档 > 接口说明 > 接口规范
接口根地址: http://gs-api.uface.uni-ubi.com/{versionNo}/{appId}/
接口形式: 接口采用 Restful 的 Web API 实现方案,通过 HTTP 请求的方式对外提供服务。
接口请求参数:所有业务接口调用时请求字段必须带上versionNo、appId和token。
字段 描述 类型 必传 说明
versionNo 沃土接口版本号 String Y 接口的功能、传输的数据模型会因版本不同而改变。通过在根地址中(接口URL前)写入版本号以使用该版本对应的接口功能。版本升级时将发送业务公告,第一版为v1
appId 添加新应用时生成 String Y 沃土平台网站添加新应用后会生成一个属于该应用的appId,以此区别不同的应用项目
token 鉴权token,接口调用凭证 String Y 沃土云端服务器需要鉴定用户是否有权调用业务接口,用户调用鉴权接口:/auth,POST,可获取token(有效期为一天,过期后需再次获取),之后每一次调用业务接口的请求都需要写入此token(建议在URL中)作为校验。

鉴权接口所需参数:appKey,timestamp(毫秒),sign,其中appKey和appSecret都是沃土平台添加创建新应用时生成,sign的算法为:MD5-32(appKey+timestamp+appSecret)
接口返回: 所有接口返回的数据,都包含三个字段,即 result、 code、 msg,分别表示处理结果( 1 成功, 0 失败)、返回码(接口统一定义)、返回信息。 result、code 和 msg 称为基本字段。
字段 描述 类型 必传 说明
result 处理结果 Int Y 1 成功, 0 失败
code 返回码 String Y 接口定义成功和错误类型码
msg 返回信息 String N 接口返回的信息,通常是错误信息
除返回基本字段,大部分接口会返回业务数据,返回的字段统一为 data, 称为业务字段。
字段 描述 类型 必传 说明
data 返回数据 Int/String/Object/List 等 Y 返回的数据,数值、字符串、对象或集合