中英文网站 API 接口文档2
如果返回的data.user.access_token 和 data.user.refresh_token 不为空,
则需要更新access_token和refresh_token
1. 获取服务器时间戳(10位)
GET/api/timestamp
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| 无 |
{
"code": "200",
"msg": "当前时间戳",
"data": {
"timestamp": 1549331446
}
}
2. 获取第三方 private_token
GET/api/privateToken
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
{
"code": "200",
"msg": "获取第三方 private_token 成功",
"data": {
"private_token": "HbrU%2Fr9g0inXyB0pmm%2FTlTqgOQ7oWY1SKY9laTOLHcldr4Y760WXIz4CxRSq%2BsR3"
}
}
3. 首页图片+背景图片
3.1首页图片 [多张]
GET/api/image/homepage/:type
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| type | int | true | 无 | type可为1-2, 对应轮播图、trending图(url中参数) |
{
"code": 200,
"msg": "获取首页图片成功",
"data": {
"images": [
{
"id": 1,
"type": "1",
"title": "1",
"title_image": "http://appapi.test/uploads/20190205/2255b7ab683f53a9333102baedb9e1c1.jpg",
"link_url": "1",
"weigh": 1
},
{
"id": 2,
"type": "1",
"title": "t pic",
"title_image": "http://appapi.test/uploads/20190205/c7c89e0822db4f94278a75ea6f051102.jpg",
"link_url": "1",
"weigh": 2
}
]
}
}
3.2 背景图片 [单张]
GET/api/image/background/:type
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| type | int | true | 无 | type可为1-5, 对应登录背景、注册付款、找回密码、找回密码发邮件、找回密码-重设密码背景(url中参数) |
{
"code": 200,
"msg": "获取背景图片成功",
"data": {
"images": {
"id": 1,
"type": "1",
"title_image": "http://appapi.test/uploads/20190205/c7c89e0822db4f94278a75ea6f051102.jpg",
"link_url": "1",
"weigh": 1
}
}
}
4. 新闻
4.1 获取新闻列表
GET/api/news/:num/:page
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| num | int | true | 无 | 每页的记录条数(url中参数) |
| page | int | true | 无 | 第几页(url中参数) |
{
"code": 200,
"msg": "获取新闻列表成功",
"data": {
"count": 2,
"news": [
{
"id": 2,
"title": "2",
"title_image": "2",
"label_name": "2",
"content": "2",
"link_url": "2",
"createtime": 1549338746,
"updatetime": 1549338746
},
{
"id": 1,
"title": "dd",
"title_image": "",
"label_name": "",
"content": "dd",
"link_url": "",
"createtime": 11,
"updatetime": 11
}
]
}
}
4.2 获取单条新闻
GET/api/news/:id
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| num | int | true | 无 | 新闻id(url中参数) |
{
"code": 200,
"msg": "获取单条新闻成功",
"data": {
"news": {
"id": 2,
"title": "2",
"title_image": "222",
"label_name": "2",
"content": "![](\"https://imgsa.baidu.com/forum/w%3D580/sign=0216a817b2096b6381195e583c338733/6b77b68fa0ec08fa596d7c9f55ee3d6d55fbda09.jpg\")
2
",
"link_url": "2",
"createtime": 1549338746,
"updatetime": 1549350517
}
}
}
5. 用户注册
5.1 获取email验证码
GET/api/getEmailCode/:email
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| string | true | 无 | email(url中参数) |
{
"code": 200,
"msg": "邮件发送成功",
"data": []
}
5.2 验证email验证码
GET/api/checkEmailCode/:email/:code
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| string | true | 无 | email(url中参数) | |
| code | int | true | 无 | 6位验证码(url中参数) |
{
"code": 200,
"msg": "验证通过",
"data": []
}
5.3 用户注册(step 1)
POST/api/register
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| string | true | 无 | ||
| password | string | true | 无 | 密码-7位以上,至少1个数字,至少1个大写字母 |
| password_confirm | string | true | 无 | 确认密码 |
| crmid | int | true | 无 | CRM_ID |
{
"code": 200,
"msg": "注册成功",
"data": {
"user": {
"id": "1",
"email": "[email protected]",
"crmid": "1",
"create_time": 1549522758
}
}
}
5.4 用户注册(step 2) -- 发送注册成功提醒邮件
GET/api/registerSucceeded/:email
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| string | true | 无 |
{
"code": 200,
"msg": "发送注册成功邮件成功",
"data": []
}
5.5 用户登录 [2019-04-04 新增refresh_token需要前端保存]
POST/api/login
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| string | true | 无 | ||
| password | string | true | 无 | 密码-7位以上,至少1个数字,至少1个大写字母 |
{
"code": 200,
"msg": "登录成功",
"data": {
"user": {
"id": 3,
"email": "[email protected]",
"crmid": 37,
"create_time": 1550805175,
"is_pay": "0",
"complete_time": 0,
"access_token": "7abab3844ef6d3da83cb8d8977be9ec7",
"refresh_token": "76ab7e51bcb1feccbe3317b90dc42c24"
}
}
}
5.6 退出登录
POST/api/logout[2019-04-04 access_token和refresh_token需要添加到请求头中]
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| access_token | string | true | 无 | 登录access_token(请求头参数) |
| refresh_token | string | true | 无 | 登录refresh_token(请求头参数) |
| string | true | 无 |
{
"code": 200,
"msg": "退出登录成功",
"data": []
}
5.7 忘记密码 -- 发送邮件
GET/api/forgetPassword/:email
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| string | true | 无 |
{
"code": 200,
"msg": "邮件发送成功",
"data": []
}
5.8 忘记密码 -- 发送邮件 -- 重置密码
POST/api/changePassword
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| password | string | true | 无 | 密码 |
| password_confirm | string | true | 无 | 确认密码 |
| t | string | true | 无 | url中获取的加密字符串 |
{
"code": 200,
"msg": "更改密码成功",
"data": []
}
5.9 判断是否登录 [2019-04-04 改: access_token和refresh_token需要添加到请求头中, 请求方式改为GET]
GETapi/isLogin/:email
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| access_token | string | true | 无 | 登录access_token(请求头参数) |
| refresh_token | string | true | 无 | 登录refresh_token(请求头参数) |
| string | true | 无 | email(url参数) |
{
"code": 200,
"msg": "登录状态",
"data": {
"is_login": false
}
}
5.10 支付成为付费会员(获取支付二维码) [2019-04-04 改, access_token和refresh_token需要添加到请求头中]
GET/api/userPay/:email
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| access_token | string | true | 无 | 登录access_token(请求头参数) |
| refresh_token | string | true | 无 | 登录refresh_token(请求头参数) |
| string | true | 无 | email(url参数) |
{
"code": 200,
"msg": "返回支付二维码",
"data": {
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKoAAAC/CAIAAADhD9D9AAAACXBIWXMAAA7E...............",
"user": {
"id": 3,
"email": "[email protected]",
"crmid": 37,
"create_time": 1550805175,
"is_pay": "0",
"complete_time": 0,
"access_token": "25103ec633d6dfd34b741588912c73d3"
}
}
}
5.11 重新评估付费 [2019-04-04 改, access_token和refresh_token需要添加到请求头中]
GET/api/reApplyPay/:email
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| access_token | string | true | 无 | 登录access_token(请求头参数) |
| refresh_token | string | true | 无 | 登录refresh_token(请求头参数) |
| string | true | 无 | email(url参数) |
{
"code": 200,
"msg": "返回支付二维码",
"data": {
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKoAAAC/CAIAAADhD9D9AAAACXBIWXMAAA7E...............",
"user": {
"id": 3,
"email": "[email protected]",
"crmid": 37,
"create_time": 1550805175,
"is_pay": "0",
"complete_time": 0,
"access_token": "25103ec633d6dfd34b741588912c73d3"
}
}
}
6. 文章 -- 需要登录
6.1 获取文章列表 [2019-04-04 改, access_token和refresh_token需要添加到请求头中]
POST/api/article/:num/:page
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| access_token | string | true | 无 | 登录access_token(请求头参数) |
| refresh_token | string | true | 无 | 登录refresh_token(请求头参数) |
| num | int | true | 无 | 每页的记录条数(url中参数) |
| page | int | true | 无 | 第几页(url中参数) |
| string | true | 无 | 用户邮箱(post参数) |
{
"code": 200,
"msg": "获取文章列表成功",
"data": {
"user": {
"id": 2,
"email": "[email protected]",
"crmid": 1,
"create_time": 1549610498,
"is_pay": "0",
"complete_time": 0,
"access_token": "d27b7390b4340bfd977e760b1cb8a960"
"refresh_token": "a2145390b4340bfd977e760b1cb8a960"
},
"count": 1,
"articles": [
{
"id": 2,
"title": "文章1",
"title_image": "123",
"label_name": "ddd",
"content": "dfdfdfd",
"price": 0,
"outer_chain": "0",
"createtime": 1549614047,
"updatetime": 1549614047,
"user_id": 2
}
]
}
}
其中 user 是用户信息(包含登录token), count 是文章总数, artilces 是文章列表
6.2 获取单个文章 [2019-04-04 改, access_token和refresh_token需要添加到请求头中]
POST/api/article/:id
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| access_token | string | true | 无 | 登录access_token(请求头参数) |
| refresh_token | string | true | 无 | 登录refresh_token(请求头参数) |
| id | int | true | 无 | 文章id(url参数) |
| string | true | 无 | 用户邮箱(post参数) |
{
"code": 200,
"msg": "获取单条新闻成功",
"data": {
"user": {
"id": 2,
"email": "[email protected]",
"crmid": 1,
"create_time": 1549610498,
"is_pay": "0",
"complete_time": 0,
"access_token": "53f6aa1c871236d30e6da3fa8ed60320"
},
"article": {
"id": 2,
"title": "文章1",
"title_image": "123",
"label_name": "ddd",
"content": "dfdfdfd
",
"price": 0,
"outer_chain": "0",
"createtime": 1549614047,
"updatetime": 1549614047,
"user_id": 2
}
}
}
7. 邮件 -- 前台发送邮件
POST/api/sendEmail
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| :from | string | true | 无 | 当前用户的邮箱(hidden框)(post参数) |
| :receiver | string | true | 无 | 接收者(顾问)的邮箱(post参数) |
| :content | string | true | 无 | 邮件内容(post参数) |
{
"code": 200,
"msg": "邮件发送成功",
"data": []
}
8. 订单 -- 轮询订单状态
GET/api/checkOrderStatus/:orderid
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| :orderid | string | true | 无 | 订单编号(url中参数) |
{
}
9. 工作经历联系人
9.1 给工作经历联系人发邮件
POST/api/sendReferenceEmail
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| user | json | true | 无 | 包含用户id及name对对象 |
| references | array | true | 无 | 联系人name和email对象构成的数组 |
user: {"id":1,"name":"guodongcai"}
references: [{"name":"guodongcai","email":"[email protected]"},{"name":"zjw","email":"[email protected]"}]
{
"code": 200,
"msg": "发送全部邮件成功",
"data": []
}
9.2 添加工作经历联系人填写的信息
GET/api/addReference/:t
| 参数 | 类型 | 必需 | 默认 | 描述 |
|---|---|---|---|---|
| Request-Timestamp | int | true | 无 | 当前时间戳(header中参数) |
| t | int | true | 无 | url中获取的加密t |
{
"code": 200,
"msg": "填写成功",
"data": []
}