星空辽阔账号系统免登 API

glzjin

6 年前

作者：glzjin

最后更新时间：2020年2月24日

一、写作目的

解释说明星空辽阔账号系统的设计以及相关 API,此文中的 API 均无需登录，适用于不需要账号体系的 APP。

二、接口具体说明

约定：

请在每个HTTP请求头加上 APPID，也就是您在系统内的 APPID。

以下无特殊说明均为 json.

0、设备激活
- 接口名称：免登设备激活
- 接口用途：用于不登录激活 APP.
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v1/simple/code/active
- 请求方法： POST
- 接口参数：
  - code={code, 激活码}
  - device_id={device_id}
  - device_info={device_info}
  - email={用户email,可选}
- 接口返回格式：
  - code=100 成功
    - token={token}请将这个 Token 保存在本地，之后的请求都要带上的。
  - code=101 激活码不存在
  - code=102 参数缺失
  - code=103 使用次数超限
  - code=104 已激活，无需激活
  - code=105 激活码还未生效或者已经过期
  - code=106 激活码去向未填写
  - code=107 激活码去向里的邮箱地址没有对应的用户

1、设备反激活
- 接口名称：免登设备反激活
- 接口用途：用于不登录反激活 APP.
- 接口地址：https://accounts.extstars.com/api/v1/simple/code/deactive
- 请求方法： POST
- 接口头：AppId+Token
- 请求参数：
  - device_id={device_id}
- 接口返回参数：
  - code=100 操作成功
  - code=101 尚未激活
  - code=102 参数不全
  - code=103 不允许反激活
  - code=104 激活码去向里的邮箱地址没有对应的用户
  - code=105 device_id 不符
2、免登获取激活信息接口
- 接口名称：免登激活信息获取
- 接口用途：用于不登录获取激活信息
- 接口头：AppId+Token
- 接口地址：https://accounts.extstars.com/api/v1/simple/code/check
- 请求方法：POST
- 接口参数格式：
  - device_id={device_id}
  - 以下参数在特定情况下可选：
    - step_key={step_key}，如果您上一次请求这个接口时得到了这个参数，那么请在此带上，否则该参数可省略。
- 接口返回参数：
  - code=100 操作成功
    - data
      - key=验证key，在请求子系统时候带上
      - expire_in=上面这个 key 的过期时间戳
      - active_order=激活次序
      - step_key=步骤 key，用于防滥用，请在下一次请求本接口时以这个字串作为参数。
  - code=101 尚未激活
  - code=102 参数不全
  - code=103 设备 id 防滥用限制
  - code=104 step_key 未提供
3、拉取升级记录
- 接口名称：拉取升级记录
- 接口用途：用于拉取升级记录
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v2/upgrade/pull
- 请求方法：GET
- 接口参数格式：无
- 接口返回参数：
  - code=100 操作成功
    - data
      - id={记录id}
      - build_version={编译版本号}
      - version_code={可视版本号}
      - download_size={下载包大小}
      - download_url={下载地址}
      - update_description={升级说明}
      - created_at={添加时间}
      - updated_at={最后更新时间}
  - code=101 APP不存在
4、创建捐赠订单
- 接口名称：创建捐赠订单
- 接口用途：用于创建捐赠订单
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v2/donation/create
- 请求方法：POST
- 接口参数格式：
  - device_id={设备 ID}
  - amount={捐赠金额}
  - pay_method={支付方式}
    - 可选以下方式
      - alipay 支付宝
      - wechat 微信二维码
      - wechat_h5 微信唤起支付
      - qqpay QQ 扫码支付
      - paypal Paypal 支付
  - 下面参数可选：
    - user_email={用户邮箱}
    - user_name={用户昵称}
    - user_link={用户链接}
- 接口返回参数：
  - code=100 操作成功
    - data
      - order_id={订单 ID}
      - order_check_token={检查状态用 token，一个小时内有效}
      - 根据选择的支付方式，会有两种参数
        
        link={浏览器打开这个链接完成支付}
      - 或者下面的
        
        qrcode={展示二维码让用户扫码支付}
  - code=101 APP不存在
  - code=102 参数不全
5、拉取捐赠记录
- 接口名称：拉取捐赠记录
- 接口用途：用于拉取捐赠记录
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v2/donation/pull
- 请求方法：POST
- HTTP 头：DonationInfoPullPassword
  - 设置了捐赠信息不公开并且设置了密码就得加上这个
- 接口参数格式：
  - 以下都可选
    - limit={返回的条目数}
    - offset={返回的条目起始位置}
    - order_type={排序依据，0或不填为按照捐赠金额返回，1为按照捐赠时间返回}
- 接口返回参数：
  - code=100 操作成功
    - data
      - id={记录id}
      - user_name={用户名}
      - user_link={用户链接}
      - avatar_url={头像链接}
  - code=101 APP不存在
  - code=102 拉取密码不正确
6、检查订单状态
- 接口名称：检查订单状态
- 接口用途：用于拉取订单状态
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v2/order/check
- 请求方法：POST
- 接口参数格式：
  - order_id={订单 ID}
  - order_check_token={检查订单用 token}
- 接口返回参数：
  - code=100 操作成功
    - data
      - id={订单id}
      - app_id={APPID}
      - amount={订单数额}
      - money={金额}
      - is_paid={是否支付，0未支付，1已支付}
      - created_at={创建时间}
      - app_donation_id={关联捐赠号}
  - code=101 APP不存在
  - code=102 参数不全
7、创建普通订单
- 接口名称：创建普通订单
- 接口用途：用于创建普通订单，购买激活码，如果用户邮箱未注册，则会帮其注册，并发送一封包含用户信息的邮件给TA。
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v2/order/create
- 请求方法：POST
- 接口参数格式：
  - user_email={用户邮箱email}
  - amount={激活码数量}
  - pay_method={支付方式}
    - 可选以下方式
      - alipay 支付宝
      - wechat 微信二维码
      - wechat_h5 微信唤起支付
      - qqpay QQ 扫码支付
      - paypal Paypal 支付
- 接口返回参数：
  - code=100 操作成功
    - data
      - order_id={订单 ID}
      - order_check_token={检查状态用 token，一个小时内有效}
      - 根据选择的支付方式，会有两种参数
        
        link={浏览器打开这个链接完成支付}
      - 或者下面的
        
        qrcode={展示二维码让用户扫码支付}
  - code=101 APP不存在
  - code=102 参数不全
  - code=103 库存不足
8、拉取指定用户捐赠记录
- 接口名称：拉取指定用户捐赠记录
- 接口用途：用于拉取指定用户捐赠记录
- 接口头：AppId
- 接口地址：https://accounts.extstars.com/api/v2/donation/search
- 请求方法：POST
- HTTP 头：DonationInfoPullPassword
  - 设置了捐赠信息不公开并且设置了密码就得加上这个
- 接口参数格式：
  - 以下都可选
    - limit={返回的条目数}
    - offset={返回的条目起始位置}
    - order_type={排序依据，0或不填为按照捐赠金额返回，1为按照捐赠时间返回}
    - user_name={用户名}
    - user_email={用户 Email}
    - user_link={用户 url}
- 接口返回参数：
  - code=100 操作成功
    - data
      - id={记录id}
      - user_name={用户名}
      - user_link={用户链接}
      - avatar_url={头像链接}
  - code=101 APP不存在
  - code=102 查询密码错误
  - code=103 请求参数不全

三、更新记录

2020年02月24日：追加拉取指定用户捐赠记录接口。