合作方API

更新: 2021-5-14

开通企业
获取企业信息
获取企业列表
下订单
获取管理后台登录链接
获取开发授权
获取企业统计数据
设置每日外链流量上限

API域名

Host: yk3.gokuai.com

开通企业

POST /m-api/1/thirdparty/create_ent HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
ent_name	是	企业名称
member_count	否	成员上限, 不传默认`1000`
days	否	试用天数, 不传默认三个月后到期, 试用天数不得超过90天
space	否	存储空间, 单位GB, 默认`500`, 不得超过`51200`, 即50TB
account	否	管理员帐号, 不传则不会生成管理员帐号, 管理员帐号全局唯一, 如果存在相同则开通失败
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

扩展参数

用于传递一些特殊用途的企业初始数据, 参数前缀为__setting_, 例如: __setting_site_url

成功 HTTP 200

{
  "id": 企业唯一ID(number),
  "end_dateline": 到期时间, unix时间戳(number),
  "account": 管理员帐号, 如果参数不指定则不返回(string),
  "password": 管理员密码, 如果不指定管理员帐号则不返回(string)
}

获取企业信息

POST /m-api/1/thirdparty/ent_info HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

成功 HTTP 200

{
  "id": 企业ID(number),
  "name": 企业名称(string),
  "trial": 是否试用, 1表示试用, 0表示付费企业(number),
  "end_dateline": 到期时间, unix时间戳(number),
  "member_limit": 成员数量上限(number),
  "member_count": 成员数量(number),
  "space": 空间上限, 单位字节(number),
  "size": 已使用空间, 单位字节(number)
}

获取企业列表

POST /m-api/1/thirdparty/ent_list HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
begin_date	否	获取开通日期 >= `begin_date`的企业, 格式: `2021-04-25`
end_date	否	获取开通时日期 < `end_date`的企业, 格式: `2021-04-25`
start	否	开始位置, 默认`0`
size	否	获取数据条数, 默认`100`, 最多返回`1000`条
order	否	排序方式, 默认`asc`按开通顺序排列, `desc`倒序排列
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

成功 HTTP 200

{
  "list":
  [
    {
      "id": 企业ID(number),
      "out_id": 企业在合作方系统中的唯一ID(string),
      "name": 企业名称(string),
      "trial": 是否试用, 1表示试用, 0表示付费企业(number),
      "end_dateline": 到期时间, unix时间戳(number),
      "member_limit": 成员数量上限(number),
      "member_count": 成员数量(number),
      "space": 空间上限, 单位字节(number),
      "size": 已使用空间, 单位字节(number),
      "account": 管理员帐号(string)
    },
    ...
  ]
}

下订单

POST /m-api/1/thirdparty/order HTTP/1.1

需够快授权代理商才能调用, 操作立即生效

请求公共参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

试用延期

参数	必需	说明
type	是	固定值`trial.extend`
days	是	延期天数

购买时参数

参数	必需	说明
type	是	固定值`subscribe`
member_count	是	人数
space	是	空间(GB)
month	是	购买的月数

续费时参数

参数	必需	说明
type	是	固定值`renew`
month	是	续费月数

升级时参数

参数	必需	说明
type	是	固定值`upgrade`
member_count	是	新增人数
space	是	新增空间(GB)

退订参数

参数	必需	说明
type	是	固定值`unsubscribe`

成功 HTTP 200

获取开发授权

POST /m-api/1/thirdparty/get_client_id HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
title	是	调用方名称, 备注用
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

成功 HTTP 200

{
  "client_id": "授权ID",
  "client_secret": "授权密钥"
}

获取管理后台登录链接

POST /m-api/1/thirdparty/ent_sso_url HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

成功 HTTP 200

{
  "url": 管理后台登录链接(string)
}

获取企业统计数据

POST /m-api/1/thirdparty/ent_daily_stats HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
type	是	统计数据类型, `flow`表示查询流量
start_date	是	开始日期(包含该日数据), 格式 `2021-02-23`
end_date	否	结束日期(包含该日数据), 不传默认查询到最新的一天, 格式 `2021-02-23`
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

注意: 统计数据并非实时, 当天的数据在后一天才能查询, 一次查询最多返回一年的数据量

成功 HTTP 200

{
  "list":
      [
          {
              "date": 日期, 如: 2021-02-23(string),
              "download": 普通下载流量, 单位字节(number),
              "link": 外链下载流量, 单位字节(number),
              "preview": 预览流量, 单位字节(number)
          },
      ...
      ]
}

设置每日外链流量上限

POST /m-api/1/thirdparty/set_ent_setting HTTP/1.1

请求参数

参数	必需	说明
client_id	是	够快分配的client_id
out_id	是	企业在合作方系统中的唯一ID
max_link_flow	是	每日外链流量上限, 单位字节, -1表示不限
dateline	是	当前unix时间戳, 单位秒
sign	是	签名

注意: 试用企业设置无效

成功 HTTP 200