




版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報或認(rèn)領(lǐng)
文檔簡介
1、XXAPI接口設(shè)計說明書公司2016年11月25日文檔管理信息表主題XX api接口設(shè)計說明書 版本V0.1內(nèi)容關(guān)鍵字參考文檔創(chuàng)建時間創(chuàng)建人最新發(fā)布日期文檔變更記錄表修改人修改時間修改內(nèi)容創(chuàng)建目 錄文檔變更記錄表3目 錄1引言1編寫目的1背景1定義1參考資料1綜述2統(tǒng)一的輸入輸出參數(shù)2必須登錄才能訪問的接口2錯誤返回碼列表3用戶接口4用戶注冊(user/signup)4用戶登錄(user/signin)5優(yōu)惠券接口9我的優(yōu)惠券(coupon/mycoupon)9引言編寫目的說明編寫這份用戶手冊的目的,指出預(yù)期的讀者。背景說明:a這份用戶手冊所描述的軟件系統(tǒng)的名稱;b該軟件項(xiàng)目的任務(wù)提出者、開發(fā)
2、者、用戶(或首批用戶)及安裝此軟件的的計算站中心。定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。參考資料列出有用的參考資料,如:a本項(xiàng)目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機(jī)關(guān)的批文;b屬于本項(xiàng)目的其它已發(fā)表的文件;c本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。綜述統(tǒng)一的輸入輸出參數(shù)Request參數(shù)名類型是否必須描述languageStringYcn:中文,en:英文,th:泰文uidIntY用戶ID. sidStringYSessonId(TOKEN)(不需要登錄就能調(diào)用的接口、
3、注冊接口、登錄接口,uid和sid兩個參數(shù)不需要輸入)Response參數(shù)名類型是否必須描述succeedIntY0:失敗,1:成功error_codeIntN錯誤碼error_descStringN錯誤消息必須登錄才能訪問的接口接口名稱描述user/signout用戶退出user/photoupload照片上傳user/changeprofile修改用戶資料user/changepassword修改用戶密碼user/info獲取用戶信息錯誤返回碼列表error_codeerror_desc1授權(quán)過期500服務(wù)器內(nèi)部錯誤600賬號被鎖定10001手機(jī)號碼不能為空10002密碼不能為空10003
4、驗(yàn)證碼不能為空10004平臺類型不正確10005手機(jī)驗(yàn)證碼不正確10006手機(jī)驗(yàn)證碼已失效10007用戶類型不正確10008用戶名不能為空10009原密碼不能為空10010新密碼不能為空10011原密碼不正確10012經(jīng)度不能為空10013緯度不能為空10014對象用戶ID不能為空用戶接口用戶注冊(user/signup)接口user/signup描述用戶注冊驗(yàn)證Session方法GET/POSTRequest參數(shù)名類型是否必須描述mobileIntY注冊手機(jī)號. verify_codeStringY手機(jī)驗(yàn)證碼passwordStringY密碼platformStringY平臺類型(ios,a
5、ndroid)Response參數(shù)名類型是否必須描述sidStringYSessonId(TOKEN)uidIntY用戶IDExampleRequest mobile: , verify_code: , password: , platform: androidResponse1.錯誤情況 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注冊手機(jī)號. (type=1時必須)usernameStringN用戶名(type=2、3、4時必須)passwordStringN密碼(type=1時必須)typeIntY用戶類型1:手機(jī)號2:QQ3:微信4:微博platformStringY平臺類型(ios,android)Response參數(shù)名類型是否必須描述sidStringYSessonId(TOKEN)userArrayY用戶信息idIntY用戶IDuser_groupIntY用戶角色1:普通用戶2:專車車主nicknameStringY昵稱emailStringY郵箱mo
7、bileStringY手機(jī)號nameStringY姓名usernameStringY用戶名genderIntY性別0:男1:女a(chǎn)geIntY年齡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
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 德育共同體概念及其在中醫(yī)藥高校中的應(yīng)用探索
- 浙江省慈溪市2025屆九年級化學(xué)第一學(xué)期期末教學(xué)質(zhì)量檢測模擬試題含解析
- 焦作市2024-2025學(xué)年物理八上期末復(fù)習(xí)檢測模擬試題含解析
- 汕頭市金平區(qū)2024年九上化學(xué)期末教學(xué)質(zhì)量檢測模擬試題含解析
- 治沙工程草場租賃與生態(tài)補(bǔ)償合同
- 專業(yè)藝術(shù)品典當(dāng)質(zhì)押貸款服務(wù)合同
- 冷鏈物流監(jiān)控產(chǎn)業(yè)鏈構(gòu)建策略研究
- 2025至2030中國集成驅(qū)動器和電機(jī)行業(yè)項(xiàng)目調(diào)研及市場前景預(yù)測評估報告
- 記者年度新聞報道與行業(yè)分析總結(jié)
- 2025至2030中國旅游地產(chǎn)期間行業(yè)產(chǎn)業(yè)運(yùn)行態(tài)勢及投資規(guī)劃深度研究報告
- 安全教育培訓(xùn):實(shí)現(xiàn)安全文明施工
- 2025至2030分布式能源行業(yè)市場深度調(diào)研及發(fā)展規(guī)劃及有效策略與實(shí)施路徑評估報告
- 反邪教宣講課件
- 2025年全國統(tǒng)一高考英語Ⅰ卷(含答案)
- 1 感受生活中的法律 課件-道德與法治六年級上冊統(tǒng)編版
- 中醫(yī)集市活動方案
- 2025年云南普洱市墨江天下一雙文旅體育集團(tuán)有限公司招聘筆試參考題庫附帶答案詳解
- 水合肼項(xiàng)目安全評價報告
- 新版機(jī)動車檢驗(yàn)檢測機(jī)構(gòu)程序文件模板
- GB∕T 1001.1-2021 標(biāo)稱電壓高于1000V的架空線路絕緣子 第1部分:交流系統(tǒng)用瓷或玻璃絕緣子元件 定義、試驗(yàn)方法和判定準(zhǔn)則
- DB11_T 1832.9-2022 建筑工程施工工藝規(guī)程 第9部分_屋面工程
評論
0/150
提交評論