1、XXAPI接口設計說明書公司2016年11月25日文檔管理信息表主題XXapi接口設計說明書版本V0.1內容關鍵字參考文檔創建時間創建人最新發布日期文檔變更記錄表修改人修改時間修改內容創建目錄引言編寫目的說明編寫這份用戶手冊的目的，指出預期的讀者。）背景說明：a. 這份用戶手冊所描述的軟件系統的名稱；b. 該軟件項目的任務提出者、開發者、用戶（或首批用戶）及安裝此軟件的的計算站中心。定義列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。參考資料列出有用的參考資料，如：a. 本項目的經核準的計劃任務書或合同、上級機關的批文；b. 屬于本項目的其它已發表的文件；c. 本文件中各處引用的文件

2、、資料、包括所要用到的軟件開發標準。列出這些文件資料的標題、文件編號、發表日期和出版單位，說明能夠得到這些文件資料的來源。綜述統一的輸入輸出參數RequestlanguageStringYcn:中文，en:英文，th:泰文uidIntY用戶ID.sidStringYSessonId(TOKEN（不需要登錄就能調用的接口、注冊接口、登錄接口,uid和sid兩個參數不需要輸入）Response0:失敗，1:成功0:失敗，1:成功0:失敗，1:成功succeedIntYerrorcodeInt錯誤碼errordescString錯誤消息必須登錄才能訪問的接口錯誤返回碼列表接口名稱描述user/sig

3、nout用戶退出user/photoupload照片上傳user/changeprofile修改用戶資料user/changepassword修改用戶密碼user/info獲取用戶信息error_codeerror_desc1授權過期500服務器內部錯誤600賬號被鎖定10001手機號碼不能為空10002密碼不能為空10003驗證碼不能為空10004平臺類型不正確10005手機驗證碼不正確10006手機驗證碼已失效10007用戶類型不正確10008用戶名不能為空10009原密碼不能為空10010新密碼不能為空10011原密碼不正確10012經度不能為空10013緯度不能為空10014對象用戶I

4、D不能為空用戶接口用戶注冊(user/signup)Example接口user/signup描述用戶注冊驗證Session方法GET/POSTRequestmobileIntY注冊手機號.verify_codeStringY手機驗證碼passwordStringY密碼platformStringY平臺類型(ios,android)ResponsesidStringYSessonId(TOKENuidIntY用戶IDRequest("mobile":"verify_code":"123456","password”:"

5、;111111”,"platform":"android"Response1.錯誤情況("succeed":0,"error_code”:10006,"error_desc":"手機驗證碼已失效2.正常情況"sid":"sess_573d27b370dc7","uid":"28","succeed":1)用戶登錄(user/signin)Response接口user/signin描述用戶登錄驗證S

6、ession方法GET/POSTRequestmobileIntN注冊手機號.（type=1時必須）usernameStringN用戶名（type=2、3、4時必須）passwordStringN密碼（type=1時必須）typeIntY用戶類型1:手機號2:QQ3:微信4:微博platformStringY平臺類型（ios,android）sidStringYSessonId(TOKENuserArrayY用戶信息idIntY用戶ID用戶角色user_groupIntY1:普通用戶2:專車車主nicknameStringY昵稱emailStringY郵箱mobileStringY手機號nam

7、eStringY姓名usernameStringY用戶名性別genderIntY0:男1:女ageIntY年齡birthdayStringY出生日期avatarStringY頭像URLjoined_atStringY注冊時間ExampleRequest"mobile":"password":"111111","platform":"android")Response1. 錯誤情況"succeed”:0,"error_code”:2003,"error_desc&qu

8、ot;:"密碼錯誤")2. 正常情況"sid":"sess_573d285820a42","user":"id":3,"user_group":1,"nickname”:"test001”,"email":"mobile":"name":"王小二","username":"","gender":0,"age":26,"birthday":"1985-10-10","avatar":"/travel/public/uploadFile/avatar/empty.png","joine