中英文网站接口文档

中英文网站 API 接口文档


0. 获取第三方 private_token

GET /api/privateToken/:time

参数 类型 必需 默认 描述
time int true 当前时间
{
    "code": "200",
    "msg": "private_token",
    "data": {
        "private_token": "5TUCfxi16dGelanAXotOG%2B4Bx%2FML7dch9UxlESmJqgnlXtaqSN7aHNrAloiaNxsG"
    }
}

1. 图形验证码

1.1 获取 - 图形验证码

GET /api/captcha/send

参数 类型 必需 默认 描述
time int true 当前时间
{
    "code": 1,
    "msg": "验证码获取成功",
    "time": "1546255229",
    "data": {
        "captcha_key": "captcha-469285874176123",
        "expired_at": "有效期为5分钟",
        "captcha_image_content": "data:image/jpeg;base64...."
    }
}

1.2 校验 - 图形验证码

POST /api/captcha/check

参数 类型 必需 默认 描述
time int true 当前时间
captcha_key string true 验证码key
captcha_code string true 验证码
{
    "code": 1,
    "msg": "验证码校验成功",
    "time": "1546256418",
    "data": null
}

2.用户注册-登录-改密码

2.1 获取email验证码

GET /api/getEmailCode/:time/:email

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
{
    "code": 200,
    "msg": "验证码发送成功,10分钟内有效,请注意查收!",
    "data": []
}

2.2 验证email验证码

POST /api/checkEmailCode/:time

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
emailCode string true 验证码
{
    "code": "200",
    "msg": "验证码正确",
    "data": []
}

2.3 用户注册(注册付费见6.1)

POST /api/register/:time

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
password string true 密码
password2 string true 重复密码
c_id string? true CRM对应id
{
    "code": "200",
    "msg": "用户注册成功",
    "data": {
        "userId": 6 //返回本地数据库用户id
    }
}

2.4 用户登录

POST /api/login/:time

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
password string true 密码
{
    "code": 200,
    "msg": "登录成功",
    "data": {
        "id": "6",
        "email": "1559296636@qq.com",
        "c_id": "123",
        "create_time": "2019-01-10 11:48:09",
        "is_pay": "0",
        "complete_time": null,
        "token": "d7fa6fff8f2443672f6e2d5350920ce9"
    }
}

2.5 退出登录

POST /api/logout/:time

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
token string true token
{
    "code": "200",
    "msg": "退出登录成功",
    "data": []
}

2.6 检测email是否存在于本地数据库

GET /api/checkEmailExists/:time/:email/:is

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
is string true 是否希望存在

is == 2 时, 希望存在,并返回完整结果=> 符合期望200,不符合400;
is == 3 时, 希望不存在,并返回完整结果=>符合期望200,不符合400

{
    "code": 200,
    "msg": "邮箱已注册",
    "data": []
}

2.7 忘记密码-发送密码重置邮件

GET /api/forgetPwd/:time/:email

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 邮箱
{
    "code": 200,
    "msg": "密码重置邮件发送成功,30分钟内有效,请注意查收!",
    "data": []
}

2.7 忘记密码-重置密码

GET /api/changePwd/:time

参数 类型 必需 默认 描述
time int true 当前时间戳
t string true 从邮件url中获取的加密字符串
password string true 密码
password2 string true 重复密码
{
    "code": "200",
    "msg": "重置密码成功",
    "data": []
}

2.8 判断登录状态

POST /api/checkLogin/:time

参数 类型 必需 默认 描述
time int true 当前时间戳
email string true 用户邮箱
token string true token
{
    "code": "200",
    "msg": "已登录",
    "data": {
        "id": "8",
        "email": "1559296632@qq.com",
        "c_id": "8",
        "create_time": "2019-01-21 10:13:17",
        "is_pay": "1",
        "complete_time": "2019-01-21 10:48:02",
        "token": "66272c0d5949d160408656baae134a78"
    }
}

如果token有效,返回新的token及当前用户信息; 如果token无效,则报400

3. 新闻

3.1 获取新闻列表

GET /api/news/:time/:num/:page

参数 类型 必需 默认 描述
time int true 当前时间
num int true 每页的个数
page int true 第几页
{
    "code": 200,
    "msg": "查询成功!",
    "data": {
        "news": [
            {
                "id": "1",
                "title": "新闻1",
                "content": "新闻1",
                "img_url": "/Uploads/Picture/2019-01-09/5c358626aa2b7.png",
                "label_name": "新闻1",
                "link_url": "",
                "create_time": "2019-01-08 14:10:27"
            }
        ],
        "count": 3// 总条数
    }
}

3.2 获取新闻详情

GET /api/news/:time/:id

参数 类型 必需 默认 描述
time int true 当前时间
id int true 新闻id
{
    "code": 200,
    "msg": "查询成功!",
    "data": {
        "news": {
            "id": "1",
            "title": "新闻1",
            "content": "新闻1",
            "img_url": "/Uploads/Picture/2019-01-09/5c358626aa2b7.png",
            "label_name": "新闻1",
            "link_url": "",
            "create_time": "2019-01-08 14:10:27"
        }
    }
}

4. 首页图片+背景图片

GET /api/homepage/:time/:category/:type

参数 类型 必需 默认 描述
time int true 当前时间
category string true 图片分类,可为 home 或 background
type int true 类型, 当category=home时, type可为1-2, 对应轮播图、trending图; 当category=background时,type可为1-5,对应登录背景、注册付款、找回密码、找回密码发邮件、找回密码-重设密码
{
    "code": "200",
    "msg": "首页图片",
    "data": [
        {
            "id": "1",
            "type": "1",
            "title": "首页轮播1",
            "img_url": "/Uploads/Picture/2019-01-09/5c358626aa2b7.png",
            "link_url": "",
            "order_num": "0"
        },
        {
            "id": "3",
            "type": "1",
            "title": "轮播2",
            "img_url": "/Uploads/Picture/2019-01-09/5c358626aa2b7.png",
            "link_url": "",
            "order_num": "0"
        }
    ]
}

5. 用户个人中心文章(需要登录状态)

5.1 文章列表

POST /api/article/:time/:num/:page

参数 类型 必需 默认 描述
time int true 当前时间
num int true 分页后每页条数
page int true 分页第几页
id int true 用户id
email string true 用户邮箱
token string true 登录token
{
    "code": 200,
    "msg": "查询成功!",
    "data": {
        "articles": [
            {
                "id": "3",
                "title": "文章3",
                "img_url": "",
                "label_name": "",
                "content": "文章3",
                "create_time": "2019-01-12 15:59:12",
                "price": "0",
                "outer_chain": "",
                "order_id": null,
                "user_id": null,
                "buy_time": null
            },
            {
                "id": "2",
                "title": "文章2",
                "img_url": "",
                "label_name": "",
                "content": "文章2",
                "create_time": "2019-01-12 15:58:59",
                "price": "0",
                "outer_chain": "",
                "order_id": "3",
                "user_id": "4",
                "buy_time": "2019-01-12 15:58:16"
            },
            {
                "id": "1",
                "title": "文章1",
                "img_url": "/Uploads/Picture/2019-01-09/5c358626aa2b7.png",
                "label_name": "",
                "content": "文章1文章1文章1",
                "create_time": "2019-01-11 17:59:01",
                "price": "0",
                "outer_chain": "",
                "order_id": "1",
                "user_id": "4",
                "buy_time": "2019-01-12 15:57:21"
            }
        ],
        "count": 10,// 总条数
        "user": {
            "id": "6",
            "email": "1559296636@qq.com",
            "c_id": "123",
            "create_time": "2019-01-10 11:48:09",
            "is_pay": "0",
            "complete_time": null,
            "token": "b80b833caa86da9b01737891cbba4b4d"
        }
    }
}

5.2 文章详情

POST /api/article/:time

参数 类型 必需 默认 描述
time int true 当前时间
email string true 用户邮箱
id int true 用户id
token string true 登录token
article_id int true 文章id
{
    "code": 200,
    "msg": "查询成功!",
    "data": {
        "article": {
            "id": "1",
            "title": "文章1",
            "img_url": "/Uploads/Picture/2019-01-09/5c358626aa2b7.png",
            "label_name": "",
            "content": "文章1文章1文章1",
            "create_time": "2019-01-11 17:59:01",
            "price": "0",
            "outer_chain": "",
            "order_id": "1",
            "user_id": "6",
            "buy_time": "2019-01-12 15:57:21"
        },
        "user": {
            "id": "6",
            "email": "1559296636@qq.com",
            "c_id": "123",
            "create_time": "2019-01-10 11:48:09",
            "is_pay": "0",
            "complete_time": null,
            "token": "4639ec85f67db0843f67b6f9b1d84de9"
        }
    }
}

6. 微信支付

6.1 \color{red}{注册或文章支付 - 增加了时间戳}

POST /api/native/:time

参数 类型 必需 默认 描述
time int true 当前时间
type int true 支付类型,1注册 or 2文章
user_id int true 用户id
article_id int false 文章id, 文章付费时需要

价格为0时,直接返回订单号; 价格不为0时,返回订单号和base64二维码

{
    "code": "200",
    "msg": "返回二维码图片及订单号",
    "data": {
        "src": "data:image/jpg;base64,iVBORw0KGgoAAAANSUhEUgAAAN4AAADeAQMAAABoqSz0AAAABlBMVEX///8AAABVwtN+AAABTElEQVRYhe2X0Q3DIAxELTEAI7F6RsoASK7vHAJVMsBFwkIN5fWjpueza7ZjxzfDEUdxxzrNKt53VYhnPcxat1b86NibLqweB5FHfKRzRWbiMF5x5bj4T8A4g1LeU9GBlEmBrimQFw0JwSzBXu/1rE8hmBFW4WfLPB4hBEPI9LaZBKStCoNEEnC4yg19ThlC0SfOHNdvi0bkYGSCR6UZD70IQ1hFdubIBm1EGZ647+HBzenHXRWyG8/OjLRmCcrBMtqajy5XphkLwjjDIAmSip6WLAdXUVDU/jdhiMEswX5dvKdnyMLOKRLtovIXSNvQhRgkYcbZ9DgBmSocAoGc2e5sactyML97+oSxdSxjmhzMUZ1u0VIgq0zkYPYNtDtcvHNeE4f3PnhZvU8S5jiZ5XiNbJrQ+JedQxn311ypCUcJOmHLwcdU4Y4dX4sf6lYWnWGyTT8AAAAASUVORK5CYII=",
        "order_id": "1000201901161536005337"
    }
}
{
    "code": "201",
    "msg": "生成免费注册订单,并且自动支付成功",
    "data": {
        "order_id": "1000201901181132281564"
    }
}

6.2 \color{red}{轮询订单状态 - 增加了时间戳}

POST /api/checkOrderStatus/:time

参数 类型 必需 默认 描述
time int true 当前时间
order_id int true 订单号
{
    "code": "400",
    "msg": "未支付",
    "data": []
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容

  • JCaptcha 简介 CAPTCHA 全称 Completely Automated Public Turing...
    谁在烽烟彼岸阅读 700评论 0 0
  • Python 面向对象Python从设计之初就已经是一门面向对象的语言,正因为如此,在Python中创建一个类和对...
    顺毛阅读 4,207评论 4 16
  • 我们可以借助插件来做 打开插件,找到自己需要的验证码 筛选有用的路径 把对应的视图函数也拿过来,注意还需要一个ge...
    程序员之路阅读 1,328评论 0 1
  • 第一首《问刘十九》〔唐代〕 白居易 绿蚁新醅酒, 红泥小火炉。 晚来天欲雪, 能饮一杯无? 慵懒的冬日午后,一个人...
    一朵生涯规划师阅读 353评论 0 3
  • 1.饮食要按时。最近最好吃米饭,菜要清淡一点的,不要吃酸辣的菜,肉可以首选鸡肉,不会肥腻。米饭的营养比面要均衡。(...
    轉兒阅读 210评论 0 0