API对接文档

一、接口对接介绍

接口地址请联系客服获取，客服联系方式：
1、邮箱：admin@yingren.xyz
2、telegram：@yingrenkefu

平台审核通过后，可享受1.0倍折扣。

提示

用户密钥获取方式：登录后，在右上角点击用户名进入个人中心即可查看用户密钥。

接口列表：

获取项目列表
查课
下单
批量下单
补刷订单
查询全部订单
查询指定订单
暂停指定订单
恢复指定订单

二、获取项目列表

该接口用于获取项目列表信息，包括项目编号、名称、价格、说明、启用状态。

❤️请求报文

请求URL：

/getProjects

请求方式：

post

请求Body类型：

application/x-www-form-urlencoded

请求Body参数：

字段	必填	类型	说明
userName	是	string	用户名
privateKey	是	string	用户密钥
status	否	string	项目状态过滤，on:启用状态, off:停用状态，不传默认显示全部状态的项目

请求示例：

userName=yingren&privateKey=9d62f46c0c71477db6342fa71e45a2f2

❤️响应报文

返回结果：

字段	类型	说明
msg	string	返回消息
code	int	返回状态码，200表示成功，其他表示失败
data	array	返回的数据
> projectCode	string	项目编号
> projectName	string	项目名称
> projectPrice	string	项目价格
> description	string	项目说明，其中的`<br>`在html中会显示换行
> status	string	on:启用状态, off:停用状态

成功返回示例：

{
  "msg": "操作成功",
  "code": 200,
  "data": [
    {
      "projectCode": "10010101",
      "projectName": "华医网-掌上华医app-继续教育-收藏课程 - https://www.91huayi.com/",
      "projectPrice": "0.50 / 账号",
      "description": "格式：账号 密码；<br>速率：加速；<br>考试：支持；<br>支持无查提交：支持；<br>说明：注意：可过人脸，需要在APP个人中心头像中上传手机自拍照片，如不上传，可自行让客户进入考试进行人脸识别，然后立马补刷。学习完成后申请证书时如果提示学习时长不足，可以等12小时后再申请。",
      "status": "on"
    },
    ...
   ]
}

失败返回示例：

{
  "msg": "校验失败，请检查用户名和密钥是否正确",
  "code": 500
}

三、查课

该接口用于处理用户的查课请求，包括验证用户信息、查询课程状态以及返回课程信息。

提示

对于不支持查课的项目也可以调用查课接口，此时返回的课程id:courseId固定为0，课程名:name固定为查课账号的用户名。

字段	类型	说明
msg	string	返回消息
code	int	返回状态码，200表示成功，其他表示失败
data	array	返回的数据
> orderNo	string	订单编号
> courseName	string	课程名称
> courseId	string	课程id，多个课程id以英文逗号分隔
> courseRate	string	课程学习进度
> account	string	下单账号的用户名
> password	string	下单账号的密码
> otherInfo	string	额外信息
> name	string	下单账号的姓名
> payAmount	bigdecimal	支付金额
> orderStatus	string	订单状态
> afterSalesStatus	string	售后状态
> resetNums	int	已补刷次数

字段	类型	说明
msg	string	返回消息
code	int	返回状态码，200表示成功，其他表示失败
data	object	返回的数据
> orderNo	string	订单编号
> courseName	string	课程名称
> courseId	string	课程id，多个课程id以英文逗号分隔
> courseRate	string	课程学习进度
> account	string	下单账号的用户名
> password	string	下单账号的密码
> otherInfo	string	额外信息
> name	string	下单账号的姓名
> payAmount	bigdecimal	支付金额
> orderStatus	string	订单状态
> afterSalesStatus	string	售后状态
> resetNums	int	已补刷次数