API接口設(shè)計說明書

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

2、的計算站中心。定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 參考資料列出有用的參考資料，如：a 本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機(jī)關(guān)的批文；b 屬于本項目的其它已發(fā)表的文件；c 本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號、 發(fā)表日期和出版單位，說明能夠得到這些文件資料 的來源。 綜述統(tǒng)一的輸入輸出參數(shù)RequestlanguageStringYcn:中文，en:英文，th :泰文uidIntY用戶ID.sidStringYSessonId (TOKEN（不需要登錄就能調(diào)用的接口、注冊接口、登錄接口，uid和sid兩個參數(shù)

3、不需要輸入）ResponsesucceedIntY0:失敗，1 ：成功error_codeInt錯誤碼error_descString錯誤消息必須登錄才能訪問的接口接口名稱描述user/signout用戶退出user/photoupload照片上傳user/changeprofile修改用戶資料user/changepassword修改用戶密碼user/info獲取用戶信息錯誤返回碼列表error_codeerror_desc1授權(quán)過期500服務(wù)器內(nèi)部錯誤600賬號被鎖定10001手機(jī)號碼不能為空10002密碼不能為空10003驗證碼不能為空10004平臺類型不正確10005手機(jī)驗證碼不正確1

4、0006手機(jī)驗證碼已失效10007用戶類型不正確10008用戶名不能為空10009原密碼不能為空10010新密碼不能為空10011原密碼不正確10012經(jīng)度不能為空10013緯度不能為空10014對象用戶ID不能為空用戶接口用戶注冊(user/signup )sidStringYSessonld (TOKENuidIntY用戶IDExampleRequestverify_code: 123456,接口user/signup描述用戶注冊驗證Session方法GET/POSTRequestmobileIntY注冊手機(jī)號.verify_codeStringY手機(jī)驗證碼passwordStringY密

5、碼platformStringY平臺類型(ios,android )Responsepassword: 111111platform: a ndroidResponse1. 錯誤情況succeed: 0,error_code: 10006,error_desc:手機(jī)驗證碼已失效 2. 正常情況sid: sess_573d27b370dc7,uid: 28,succeed: 1用戶登錄(user/signin )接口user/signin描述用戶登錄驗證Session方法GET/POSTRequestmobileIntN注冊手機(jī)號.(type=1 時必須)usernameStringN用戶名（t

6、ype=2、3、4時必須）passwordStringN密碼（type=1時必須）用戶類型1:手機(jī)號typeIntY2: QQ3:微信4:微博platformStringY平臺類型（ios,android ）ResponsesidStringYSessonId ( TOKENuserArrayY用戶信息idIntY用戶ID用戶角色user_groupIntY1 :普通用戶2 :專車車主nicknameStringY昵稱emailStringY郵箱mobileStringY手機(jī)號nameStringY姓名usernameStringY用戶名genderIntY性別0 :男1 ：女a(chǎn)geIntY年

7、齡birthdayStringY岀生日期avatarStringY頭像URLjoined_atStringY注冊時間ExampleRequesttype： 1,password: 111111,platform: a ndroidResponse1. 錯誤情況succeed: 0,error_code: 2003,error_desc:密碼錯誤2. 正常情況sid: sess_573d285820a42,user: id: 3,user_group: 1,ni ck name: testOOl,name:王小二,username:,gender: 0,age: 26,birthday :1985-10-10,avatar: /travel/public/uploadFile/avatar/,jo