API接口設計說明書

1、XXAPI接口設計說明書公司2016年11月25日文檔管理信息表主題XX api接口設計說明書 版本V0.1內容關鍵字參考文檔創(chuàng)建時間創(chuàng)建人最新發(fā)布日期文檔變更記錄表修改人修改時間修改內容創(chuàng)建目 錄文檔變更記錄表3目 錄1引言1編寫目的1背景1定義1參考資料1綜述2統(tǒng)一的輸入輸出參數2必須登錄才能訪問的接口2錯誤返回碼列表3用戶接口4用戶注冊（user/signup）4用戶登錄（user/signin）5優(yōu)惠券接口9我的優(yōu)惠券（coupon/mycoupon）9引言編寫目的說明編寫這份用戶手冊的目的，指出預期的讀者。背景說明：a這份用戶手冊所描述的軟件系統(tǒng)的名稱；b該軟件項目的任務提出者、開發(fā)

2、者、用戶（或首批用戶）及安裝此軟件的的計算站中心。定義列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。參考資料列出有用的參考資料，如：a本項目的經核準的計劃任務書或合同、上級機關的批文；b屬于本項目的其它已發(fā)表的文件；c本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。綜述統(tǒng)一的輸入輸出參數Request參數名類型是否必須描述languageStringYcn:中文，en:英文，th：泰文uidIntY用戶ID. sidStringYSessonId（TOKEN）（不需要登錄就能調用的接口、

3、注冊接口、登錄接口，uid和sid兩個參數不需要輸入）Response參數名類型是否必須描述succeedIntY0：失敗，1：成功error_codeIntN錯誤碼error_descStringN錯誤消息必須登錄才能訪問的接口接口名稱描述user/signout用戶退出user/photoupload照片上傳user/changeprofile修改用戶資料user/changepassword修改用戶密碼user/info獲取用戶信息錯誤返回碼列表error_codeerror_desc1授權過期500服務器內部錯誤600賬號被鎖定10001手機號碼不能為空10002密碼不能為空10003

4、驗證碼不能為空10004平臺類型不正確10005手機驗證碼不正確10006手機驗證碼已失效10007用戶類型不正確10008用戶名不能為空10009原密碼不能為空10010新密碼不能為空10011原密碼不正確10012經度不能為空10013緯度不能為空10014對象用戶ID不能為空用戶接口用戶注冊（user/signup）接口user/signup描述用戶注冊驗證Session方法GET/POSTRequest參數名類型是否必須描述mobileIntY注冊手機號. verify_codeStringY手機驗證碼passwordStringY密碼platformStringY平臺類型（ios,a

5、ndroid）Response參數名類型是否必須描述sidStringYSessonId（TOKEN）uidIntY用戶IDExampleRequest mobile: , verify_code: , password: , platform: androidResponse1.錯誤情況 succeed: 0, error_code: 10006, error_desc: 手機驗證碼已失效2.正常情況sid: sess_573d27b370dc7,uid: 28, succeed: 1用戶登錄（user/signin）接口user/signin描述用戶登錄驗證Session方法GET/POS

6、TRequest參數名類型是否必須描述mobileIntN注冊手機號. (type=1時必須)usernameStringN用戶名(type=2、3、4時必須)passwordStringN密碼(type=1時必須)typeIntY用戶類型1：手機號2：QQ3：微信4：微博platformStringY平臺類型（ios,android）Response參數名類型是否必須描述sidStringYSessonId（TOKEN）userArrayY用戶信息idIntY用戶IDuser_groupIntY用戶角色1：普通用戶2：專車車主nicknameStringY昵稱emailStringY郵箱mo

7、bileStringY手機號nameStringY姓名usernameStringY用戶名genderIntY性別0：男1：女ageIntY年齡birthdayStringY出生日期avatarStringY頭像URLjoined_atStringY注冊時間ExampleRequest type: 1, mobile: , password: , platform: androidResponse1.錯誤情況 succeed: 0, error_code: 2003, error_desc: 密碼錯誤2.正常情況 sid: sess_573da42, 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.pn