## 接口概述
### 一、調用協議
接口使用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
- 獲取用戶信息
- 找回密碼
- 修改密碼
- 修改姓名
- 修改昵稱
- 修改導游證號
- 修改性別
- 修改頭像
- 修改綁定手機號
- 修改所屬地區
- 修改簽名
- 切換用戶當前身份
- 導游接口
- 行程單列表
- 行程單詳情
- 日程條目信息
- 新建日程條目
- 修改日程條目
- 刪除日程條目
- 旅行社詳情
- 全部物品列表
- 修改行程物品清單
- 行程單游客列表
- 游客詳情
- 行程房間列表
- 修改房間號
- 行程記賬本清單
- 記賬條目詳情
- 新建記賬條目
- 記賬科目字典
- 修改記賬條目
- 刪除記賬條目
- 清空行程的記賬本
- 行程記事本列表
- 新建記事本條目
- 記事本條目詳情
- 修改記事本條目
- 刪除記事本條目
- 清空一個行程的記事本
- 行程單重要電話列表
- 新建行程單重要電話
- 修改行程單重要電話
- 行程單重要電話詳情
- 刪除一條行程單重要電話
- 清空一個行程單的重要電話
- 崗位列表
- 常用聯系人列表
- 新建聯系人
- 聯系人詳情
- 修改聯系人
- 刪除聯系人
- 清空聯系人
- 設定當前行程
- 獲取當前行程
- 當前行程導游和地接位置
- 獲取當前集合點
- 集合點簽到情況
- 集合點簽到詳情
- 全部簽到
- 手工給一個游客簽到
- 創建集合點
- 修改集合點
- 停止集合點
- 修改電子圍欄設置
- 講解目錄列表
- 講解目錄詳情
- 新建講解目錄
- 修改講解目錄
- 刪除講解目錄
- 講解列表
- 講解詳情
- 新建講解
- 修改講解
- 刪除講解
- 消息列表
- 未讀消息數量
- 消息詳情
- 點贊或取消點贊
- 被贊列表
- 點贊列表
- 點贊狀態統計
- 我收到的贊的總數
- 導游上報坐標
- 游客接口
- 游客當前行程
- 游客上報坐標
- 游客行程列表
- 游客獲取當前集合點
- 游客點贊被贊情況
- 輔助工具
- 七牛上傳憑證