## 接口概述
### 一、调用协议
接口使用HTTP协议调用,遵循RESTful架构风格。
### 二、请求方式
GET:查看资源;
POST:创建资源或提交数据;
PUT:更新或创建资源;
PATCH:修改资源部分属性
DELETE:删除资源
每个接口使用的请求方式不同,具体请参见接口说明。
对于PUT、PATCH、DELETE类型的请求,客户端需要使用POST请求方式,并提供一个HTTP头X-HTTP-Method-Override来指明请求的方式,例如:
~~~
POST:/user/info
X-HTTP-Method-Override: PUT
~~~
### 三、调用URL:
~~~
http://api.odaoyou.com
~~~
### 四、版本标记
版本标记通过HTTP头传送,请在请求的HTTP头中包含一个Accept头,值为
~~~
application/vnd.travelmate.v1+json
~~~
### 五、登录状态保持
本系统使用JWT(Json Web Token)机制保持客户端登录状态,对于需要验证身份后才能访问的接口,客户端必须提供token方能访问。客户端需要通过HTTP头Authorization携带token,请在请求的HTTP头中包含一个Authorization头,其值为
~~~
Bearer+一个半角空格+token值
~~~
范例:
~~~
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjUsImlzcyI6Imh0dHA6XC9cL2FwaS5vZGFveW91LmNvbVwvYXV0aFwvcmVnaXN0ZXIiLCJpYXQiOjE0NjcwODM3NjMsImV4cCI6MTQ2NzA4NzM2MywibmJmIjoxNDY3MDgzNzYzLCJqdGkiOiI3MTA1YTFkYzgxYTZjYTQyYjc0N2Q5NGQ1MjM4ZDQ3NCJ9.IZeE07eogJHk653s8a-tXuQNUz5ziE-aX2cQDLNTlPo
~~~
- 序言
- 接口概述
- 返回格式
- iOS消息推送格式定义
- 旅行社邀请导游消息推送
- 导游接受旅行社邀请消息推送
- 导游拒绝旅行社邀请消息推送
- 游客加入行程提醒消息推送
- 行程分配提醒消息推送
- 行程物品清单消息推送
- 界面初始化接口
- 用户接口
- 获取短信验证码
- 用户注册
- 用户登录
- 注销登录
- 刷新token
- 获取用户信息
- 找回密码
- 修改密码
- 修改姓名
- 修改昵称
- 修改导游证号
- 修改性别
- 修改头像
- 修改绑定手机号
- 修改所属地区
- 修改签名
- 切换用户当前身份
- 导游接口
- 行程单列表
- 行程单详情
- 日程条目信息
- 新建日程条目
- 修改日程条目
- 删除日程条目
- 旅行社详情
- 全部物品列表
- 修改行程物品清单
- 行程单游客列表
- 游客详情
- 行程房间列表
- 修改房间号
- 行程记账本清单
- 记账条目详情
- 新建记账条目
- 记账科目字典
- 修改记账条目
- 删除记账条目
- 清空行程的记账本
- 行程记事本列表
- 新建记事本条目
- 记事本条目详情
- 修改记事本条目
- 删除记事本条目
- 清空一个行程的记事本
- 行程单重要电话列表
- 新建行程单重要电话
- 修改行程单重要电话
- 行程单重要电话详情
- 删除一条行程单重要电话
- 清空一个行程单的重要电话
- 岗位列表
- 常用联系人列表
- 新建联系人
- 联系人详情
- 修改联系人
- 删除联系人
- 清空联系人
- 设定当前行程
- 获取当前行程
- 当前行程导游和地接位置
- 获取当前集合点
- 集合点签到情况
- 集合点签到详情
- 全部签到
- 手工给一个游客签到
- 创建集合点
- 修改集合点
- 停止集合点
- 修改电子围栏设置
- 讲解目录列表
- 讲解目录详情
- 新建讲解目录
- 修改讲解目录
- 删除讲解目录
- 讲解列表
- 讲解详情
- 新建讲解
- 修改讲解
- 删除讲解
- 消息列表
- 未读消息数量
- 消息详情
- 点赞或取消点赞
- 被赞列表
- 点赞列表
- 点赞状态统计
- 我收到的赞的总数
- 导游上报坐标
- 游客接口
- 游客当前行程
- 游客上报坐标
- 游客行程列表
- 游客获取当前集合点
- 游客点赞被赞情况
- 辅助工具
- 七牛上传凭证