API接口設(shè)計(jì)說(shuō)明書(shū)

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

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

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

4、驗(yàn)證碼不能為空10004平臺(tái)類型不正確10005手機(jī)驗(yàn)證碼不正確10006手機(jī)驗(yàn)證碼已失效10007用戶類型不正確10008用戶名不能為空10009原密碼不能為空10010新密碼不能為空10011原密碼不正確10012經(jīng)度不能為空10013緯度不能為空10014對(duì)象用戶ID不能為空用戶接口用戶注冊(cè)（user/signup）接口user/signup描述用戶注冊(cè)驗(yàn)證Session方法GET/POSTRequest參數(shù)名類型是否必須描述mobileIntY注冊(cè)手機(jī)號(hào). verify_codeStringY手機(jī)驗(yàn)證碼passwordStringY密碼platformStringY平臺(tái)類型（ios,a

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

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

7、bileStringY手機(jī)號(hào)nameStringY姓名usernameStringY用戶名genderIntY性別0：男1：女a(chǎn)geIntY年齡birthdayStringY出生日期avatarStringY頭像URLjoined_atStringY注冊(cè)時(shí)間ExampleRequest type: 1, mobile: , password: , platform: androidResponse1.錯(cuò)誤情況 succeed: 0, error_code: 2003, error_desc: 密碼錯(cuò)誤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