zyw-api文档2

中英文网站 API 接口文档2

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": "<p><img src=\"https://imgsa.baidu.com/forum/w%3D580/sign=0216a817b2096b6381195e583c338733/6b77b68fa0ec08fa596d7c9f55ee3d6d55fbda09.jpg\" style=\"width: 470px;\">2</p>",
            "link_url": "2",
            "createtime": 1549338746,
            "updatetime": 1549350517
        }
    }
}

5. 用户注册

5.1 获取email验证码

GET /api/getEmailCode/:email

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email(url中参数)

{
    "code": 200,
    "msg": "邮件发送成功",
    "data": []
}

5.2 验证email验证码

GET /api/checkEmailCode/:email/:code

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	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中参数)
email	string	true	无	email
password	string	true	无	密码-7位以上,至少1个数字,至少1个大写字母
password_confirm	string	true	无	确认密码
crmid	int	true	无	CRM_ID

{
    "code": 200,
    "msg": "注册成功",
    "data": {
        "user": {
            "id": "1",
            "email": "1559296632@qq.com",
            "crmid": "1",
            "create_time": 1549522758
        }
    }
}

5.4 用户注册(step 2) -- 发送注册成功提醒邮件

GET /api/registerSucceeded/:email

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email

{
    "code": 200,
    "msg": "发送注册成功邮件成功",
    "data": []
}

5.5 用户登录

POST /api/login

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email
password	string	true	无	密码-7位以上,至少1个数字,至少1个大写字母

{
    "code": 200,
    "msg": "登录成功",
    "data": {
        "user": {
            "id": 4,
            "email": "1559296632@qq.com",
            "crmid": 1,
            "create_time": 1549547531,
            "is_pay": "0",
            "complete_time": 0,
            "access_token": "dd40bc87a30606139b393ff3ff7ef449"
        }
    }
}

5.6 退出登录

POST /api/logout

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email
access_token	string	true	无	登录token

{
    "code": 200,
    "msg": "退出登录成功",
    "data": []
}

5.7 忘记密码 -- 发送邮件

GET /api/forgetPassword/:email

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email

{
    "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 判断是否登录

POST /api/isLogin

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email
access_token	string	true	无	登录token

{
    "code": 200,
    "msg": "登录状态",
    "data": {
        "is_login": false
    }
}

5.10 支付成为付费会员

POST /api/userPay/:email

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
email	string	true	无	email
access_token	string	true	无	登录token

{
    "code": 200,
    "msg": "返回支付二维码",
    "data": {
        "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKoAAAC/CAIAAADhD9D9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAJ+UlEQVR4nO2dTWzcxhXHn7xaS81K/khtp05rkIlRx3HRyEaKflxKukibBAh6Tg8BafhaxwWKJrnt6tBDDzkUPQToZXkoihYNcih6Kpwu10CKXoKiTuKkhRJyXSFRExuxLUuWVittDw+e0OSK1OzwU+/9DoJ2OBzO7p9v+OfMcDgxHA6BocqeoivAFAnLTxqWnzQsP2lYftKw/KRh+UnD8pOG5SfNZPzmiYmJfOoBAFL9j6GKRfdVqXmotGhRKl2lef6kkFRVjn7SsPykYflJw/KTJsH6hUh3dDjeBMVvTdedydqxeOOZaEt3vlUW2S/C0U8alp80LD9pWH7SyFm/EFJGQ9HjyO6u4s4y7VJMJM9flaOfNCw/aVh+0rD8pFGyfgWSrvmS7X/MsyMvUzj6ScPyk4blJw3LT5ryWj+VUdRofpWutOi+eXbMZQpHP2lYftKw/KRh+UmjZP0KNDXp9vop2swQinXL81fl6CcNy08alp80LD9pWH7SyDn/PB9OTnc2ZmI/bop1UykqZzj6ScPyk4blJw3LT5oE61fmsep4CnzoukITQTn6ScPyk4blJw3LTxq5ZR0zXYhGqnDZqZ4qTjCxYy7FJSQVC5cViKOfNCw/aVh+0rD8pJlIcbBS1kCpDMIqmtB014xU8bCJ31rqV2Xrx0jA8pOG5ScNy08aOetX4MS0TMdJZb+XSi+hYn9lunD0k4blJw3LTxqWnzRFDviqoGjWUhwOlj2WLJlWlaOfNCw/aVh+0pR3Xb+x2cn1r0JT8TOFo580ck/5pOtCM/W0eaIyeyD6vdK9cYiHo580LD9pdqH12wm3B/0rt69/vL4CAA9PNZ7Yd2jf5N6iK1UA5OT/eG3lVe+ff/7fR3c2N0TiTK3+44ce/fkjZx6ebhRYt/xRGu9XnCuQ4iTGYOaYnJeu//fCe92bg/WRWw9MTv3mG8ZTh47FHCjx6Kmj4r6jGUIQuvZ3biyev3JpO+0B4OZg/fyVS50bi3nWqlioyH+9f/fi1cv94VYo/dTMg1+uT4uP/eHWxauXr/fv5lu7wqAi/2vX3vksIuqx6Zk/nnnm2wceCiZ+1r/72rV3c6xakZCQv7+1+cbSh6HE6T21337zB4f2fml50A9temNpob+1mVftikTO+SvakBDpdpbFsLBya2l99b7SAH752PdO7zsMAMuDjVD+pfXVhdVbp2Ye3K7AFJ8PT1yQMtNViUhE/+LanVDKC189+ZOjJ/D/4B3gF7vcDe+yKyFx3795v+P71v4j81//joiqP5159uZg/e1bn/7ig7e222W3QiL6D089EPz48qNPTu2piY9HpxsnGwffv/N5MM+R+3fZrZCI/pONg7O1+vK9Rv78O2/O1uonGgd/f+ZpTHl9aaG9eFXkn63VH2scLKCiuaO0oreU18t0xDa+8JnJ+tOHtdeXFvDj7UH/9qB/oD6FH99dvvHKB38P7v/MYW1msj52ZdJ9l4/K+yijpYUg0fgDwM/009OBBh8AZif3AsDnG2vnr7y5ujUQ6dN7ahf103nXryCoyH+8sf9FfS6YMjtZH2xt/fS97rW15WD6i/rc8cb+fGtXGFTkB4AL2twPA8M5i2srL/37rb/d38P/1KFjF7S5yK67ljRH/DK99qcy9+vOYOOFf/31HzeXRm797oGv/G7uR40dXPVTfFVIuuv6yZafIH+K3yTTFy/unNXNjYtXL//lUz+U/twR/denvv9ALU578RVS7ObLdBw8EXLyA8DmcKu9+P6vPnwb+/tmavWXjz957muP1yYSLoUsfxxVkR/5ZG3lD5/8BwCeP3ri6M4m+bD8cVRL/jHYffITcv5MlAyXdUz3PdhlfghEMdxV4Ll+zPiw/KTZtSN+mU7I2TVw9JOG5SdNho2/4gPe6S43mq7fzvTlPfHHSvdKxNFPGpafNCw/aVh+0ihN9ZTKnLiIjRSyPal59hmn28ub6UAaRz9pWH7SsPykYflJk+a7fDK1PHmOyhT4yiJZeLYPMz4sP2lYftKw/KRRmuqZKZk+KqXoUjO1pSrzlHhtH0YClp80LD9pWH7SyL3GMVNU5vrJkq6vVDl0sVP/OPpJw/KThuUnDctPGqUVvRVR8ZWJDqi0j+0pHlpxkmMIjn7SsPykYflJw/KThuUnjdID3gV2nVYIxY5zfsCbyQqWnzQsP2lYftJUdWE3xdUsQ8jaqxRfQJlYc6m3OsraTI5+0rD8pGH5ScPyk6Yy1i/PvrNMH/pJdwVKfsqHGR+WnzQsP2lYftIoWb88x3DTXTgoz2Ud4w+tuDu/y4cZH5afNCw/aVh+0mS4orciiq96KbCbL9P3NsbDvX6MBCw/aVh+0rD8pGH5SVPeVT2ZHODoJw3LTxqWnzQsP2lYftKw/KRh+UnD8pOG5SdN2Z/y8X0fAHRdHyPR933XdQHANM1QZtyKia7r4v+maY6sA2bAwpGYaiRuKhfDcmMYhmVZwRTP8wBgZGKn0xEfDcMAAE3T8B/DMDzPE/ktyzIMo9PpYB5N06J5hsNhu93GrYZhGIaB2drtttgKAKFdhsMhFisqU2bKLj/+xKEUVCKY2Gw2RYo4P4QwnudZlhXcBT9qmhY8YzBF5EEVhdjiQEHJoxlE4ZJftBjKLv9wOAxFkmVZGJTBsAs2Etv9+pqmNZtNkScaoHjeCDktywq1MaI+Ik/wtBtZSMmpgPwhGVB4PAkwJdTyA4CQOVSOYRji/5GnyHaSC7BJEOWHDj0c1VyVmbJbPwAwTbPVauH/wlKZpum6rm3bAOC6rqZpaNwwAyZGixJbsdhoBl3XHccJ7YLWD//RdR0dgMhvWZbjOKI0x3HwAlEJKiC/bdvnzp1Dc+66Lv7QwXPCcRw8D+CewI7jjJRfyor7vm/bdrfbNQzDNE08YtD5i+qdPXsWTxrXdbvdbugEKjMVkB8AMMJarZaQHzXAcyL4i2N6q9USJ8R2BFuCkWAJnufFnzSmaWqahqeg4ziGYVTgfu8e1ej2sW0bo1nIDwDY/od+cWycR0rrOE4wLkfmEeX7vt/tdjHcgxl83+/1eqG9Wq2WiH7RJlWCashvmqbowxF6oPzCAQhs256fnw+p6/s+Nh4ipdfrRS/z3W436Amip8jIRsW2bSwftrEU5aVo77lT0KsHbbm4U492vGDHQLvd9jzP8zzReyNy4l2AYRjNZhMTO50Odu+ECul0OqIQwzDwb/TuAO3eyDuOMlONaz/cC7tg8KH/j3oxAMCLgmiKdV23bTvaLGMG0zR7vZ6maaE8uLXVaokuYcdxRD9xqChMTzQcZYPoTF9srkfeHYwHnogV8vxIZaK/zFTufk/A8o8P2j1d1+fn55vNZoXu9wRE5U/Fn6Mh8H2/3W5X7qqPEL32M0g17vuZjGD5ScPyk4blJ83/Ac/QVHRT+CcrAAAAAElFTkSuQmCC",
        "user": {
            "id": 3,
            "email": "fowlre1@126.com",
            "crmid": 37,
            "create_time": 1550805175,
            "is_pay": "0",
            "complete_time": 0,
            "access_token": "25103ec633d6dfd34b741588912c73d3"
        }
    }
}

6. 文章 -- 需要登录

6.1 获取文章列表

POST /api/article/:num/:page

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
num	int	true	无	每页的记录条数(url中参数)
page	int	true	无	第几页(url中参数)
email	string	true	无	用户邮箱
access_token	string	true	无	登录token

{
    "code": 200,
    "msg": "获取文章列表成功",
    "data": {
        "user": {
            "id": 2,
            "email": "1559296632@qq.com",
            "crmid": 1,
            "create_time": 1549610498,
            "is_pay": "0",
            "complete_time": 0,
            "access_token": "d27b7390b4340bfd977e760b1cb8a960"
        },
        "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 获取单个文章

POST /api/article/:id

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
id	int	true	无	文章id
email	string	true	无	用户邮箱
access_token	string	true	无	登录token

{
    "code": 200,
    "msg": "获取单条新闻成功",
    "data": {
        "user": {
            "id": 2,
            "email": "1559296632@qq.com",
            "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": "<p>dfdfdfd</p>",
            "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.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":"12084899@qq.com"},{"name":"zjw","email":"1559292@qq.com"}]

{
    "code": 200,
    "msg": "发送全部邮件成功",
    "data": []
}

9.2 添加工作经历联系人填写的信息

GET /api/addReference/:t

参数	类型	必需	默认	描述
Request-Timestamp	int	true	无	当前时间戳(header中参数)
t	int	true	无	url中获取的加密t

{
    "code": 200,
    "msg": "填写成功",
    "data": []
}

最后编辑于：2019.04.04 16:41:30

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 204,293评论 6赞 478
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 85,604评论 2赞 381
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 150,958评论 0赞 337
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 54,729评论 1赞 277
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 63,719评论 5赞 366
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 48,630评论 1赞 281
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 38,000评论 3赞 397
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 36,665评论 0赞 258
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 40,909评论 1赞 299
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 35,646评论 2赞 321
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 37,726评论 1赞 330
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 33,400评论 4赞 321
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 38,986评论 3赞 307
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 29,959评论 0赞 19
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 31,197评论 1赞 260
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 44,996评论 2赞 349
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 42,481评论 2赞 342

zyw-api文档2

1. 获取服务器时间戳(10位)

2. 获取第三方 private_token

3. 首页图片+背景图片

3.1首页图片 [多张]

3.2 背景图片 [单张]

4. 新闻

4.1 获取新闻列表

4.2 获取单条新闻

5. 用户注册

5.1 获取email验证码

5.2 验证email验证码

5.3 用户注册(step 1)

5.4 用户注册(step 2) -- 发送注册成功提醒邮件

5.5 用户登录

5.6 退出登录

5.7 忘记密码 -- 发送邮件

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

5.9 判断是否登录

5.10 支付成为付费会员

6. 文章 -- 需要登录

6.1 获取文章列表

6.2 获取单个文章

7. 邮件 -- 前台发送邮件

8. 订单 -- 轮询订单状态

工作经历联系人

9.1 给工作经历联系人发邮件

9.2 添加工作经历联系人填写的信息

推荐阅读更多精彩内容