API开发文档


概述

寄云平台与第三方网站共享用户账号和业务数据。用户可以使用寄云平台账号登录第三方网站,第三方网站在用户授权后通过调用API可以获得用户信息、以及提供购买使用寄云平台产品等业务。

API调用说明

寄云平台API调用为HTTP方式,API接口采用REST风格,只需将所需参数拼装成http请求,即可调用。 调用API,必须传入系统参数和应用参数。系统参数详细介绍如下,应用参数根据具体调用的API接口不同,请参考API接口说明。

系统参数

名称 类型 是否必须 描述
time_stamp String Y 时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
client_id String Y API密钥ID
signature String Y 请求消息的签名
signature_method String N 签名方法HMAC-SHA256
version String N API的版本号,目前只支持版本号为 1
access_token String N OAuth授权得到的令牌

签名方法

  1. 根据参数名称将除签名外所有请求参数按照字母先后顺序排列
  2. 对参数名称和参数值进行URL编码
  3. 构造URL请求 参数名和参数值之间用 “=” 号连接,参数和参数之间用 “&” 号连接
  4. 构造被签名串 被签名串的构造规则为: 被签名串 = HTTP请求方式 + "\n" + uri + "\n" + url请求串 ("\n" 是换行符,不要将 "\" 转义)
  5. 将API密钥的私钥 ( client_secret ) 作为key,生成被签名串的 HMAC-SHA256 签名
  6. 将签名进行 Base64 编码
  7. 将 Base64 编码后的结果进行 URL 编码
  8. 将签名用于参数 signature 的值

用户授权

用户通过提供access_token授权第三方网站访问自己的资源,第三方网站调用需要用户授权的API时,需要提供access_token。 渠道商网站可以通过user/create接口获取access_token。

API列表

分组 API接口 描述 用户授权 备注
用户 /user/create 创建用户账号 N ----
/user/show 获取用户信息 Y ----
商品 /product/list 获取商品列表 N ----
/product/show 获取商品信息 N ----
订单 /order/create 创建订单 Y ----
/order/show 获取订单信息 Y ----
/order/pay 支付一笔订单 N 渠道商权限
/order/list 获取订单列表 Y ----
应用 /app/list 获取应用列表 Y ----
/app/show 获取应用信息 Y ----

API接口说明

API服务端地址 2562166432

创建用户账号

HTTP方法 URI路径 描述 是否需要用户授权
POST /user/create 创建用户账号 N

应用参数

名称 类型 是否必须 描述
openid String Y 第三方用户ID
username String N 用户名
email String Y 邮箱
mobile String Y 手机

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
access_token String 用户授权令牌
token_type String 令牌类型
expires_in Number 令牌有效期
uid String 用户ID

请求样例

返回样例

获取用户信息

HTTP方法 URI路径 描述 是否需要用户授权
GET/POST /user/show 获取用户信息 Y

应用参数

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
openid String 用户ID
username String 用户名
email String 邮箱
mobile String 手机

请求样例

返回样例

获取商品列表

HTTP方法 URI路径 描述 是否需要用户授权
GET/POST /product/list 获取商品列表 N

应用参数

名称 类型 是否必须 描述
page Number N 页码。取值范围:大于零的整数。默认值为1
page_size Number N 每页条数。取值范围:大于零的整数;最大值:200。默认值为40

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
total Number 结果总数
per_page Number 每页条数
current_page Number 当前页码
last_page Number 最大页码
next_page_url String 下一页URL
prev_page_url String 上一页URL
from Number 起始条数
to Number 结束条数
data Product[] 商品列表,结构参考商品信息

请求样例

返回样例

获取商品信息

HTTP方法 URI路径 描述 是否需要用户授权
GET/POST /product/show 获取商品信息 N

应用参数

名称 类型 是否必须 描述
product_id Number Y 商品ID

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
id Number 商品ID
name String 商品名称
image String 商品图片
categories String 商品类目
keywords String 关键字
content String 商品描述
addedDate Date 商品添加时间
editedDate Date 商品修改时间
status String 商品状态
unit String 商品价格单位
skus List 商品规格列表

请求样例

返回样例

创建订单

HTTP方法 URI路径 描述 是否需要用户授权
POST /order/create 创建订单 Y

应用参数

名称 类型 是否必须 描述
type String N 订单类型:new表示新购,renew表示续费,upgrade表示升级。默认值为new
isv_order_id String N 第三方订单ID
sku Number N 商品规格ID
product_id Number N 商品ID
specs String N 商品规格属性
count Number Y 购买数量。取值范围:大于零的整数
amount Number N 订单金额
company String N 公司/机构名称

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
id String 订单ID
amount Number 订单金额
createdDate Date 订单创建时间
paidDate Date 订单支付时间
status String 订单状态
payStatus String 订单支付状态
type String 订单类型

请求样例

返回样例

获取订单信息

HTTP方法 URI路径 描述 是否需要用户授权
GET/POST /order/show 获取订单信息 Y

应用参数

名称 类型 是否必须 描述
order_id String N 订单ID
isv_order_id String N 第三方订单ID

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
id String 订单ID
amount Number 订单金额
createdDate Date 订单创建时间
paidDate Date 订单支付时间
status String 订单状态
payStatus String 订单支付状态
type String 订单类型

请求样例

返回样例

支付一笔订单

HTTP方法 URI路径 描述 是否需要用户授权
POST /order/pay 支付一笔订单 N

应用参数

名称 类型 是否必须 描述
order_id String N 订单ID
isv_order_id String N 第三方订单ID
sn String N 支付交易号

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
id String 订单ID
amount Number 订单金额
createdDate Date 订单创建时间
paidDate Date 订单支付时间
status String 订单状态
payStatus String 订单支付状态
type String 订单类型
dredgeStatus String 服务状态:'0'表示开通中,'1'表示已开通

请求样例

返回样例

获取订单列表

HTTP方法 URI路径 描述 是否需要用户授权
GET/POST /order/list 获取订单列表 Y

应用参数

名称 类型 是否必须 描述
page Number N 页码。取值范围:大于零的整数。默认值为1
page_size Number N 每页条数。取值范围:大于零的整数;最大值:200。默认值为40

返回参数

名称 类型 描述
ret Number 返回码
msg String 如果ret>0,会有相应的错误信息提示
total Number 结果总数
per_page Number 每页条数
current_page Number 当前页码
last_page Number 最大页码
next_page_url String 下一页URL
prev_page_url String 上一页URL
from Number 起始条数
to Number 结束条数
data Order[] 订单列表,结构参考订单信息

请求样例

返回样例