API接口设计说明书Word下载.docx

API接口设计说明书Word下载.docx

《API接口设计说明书Word下载.docx》由会员分享，可在线阅读，更多相关《API接口设计说明书Word下载.docx（8页珍藏版）》请在冰点文库上搜索。

编写目的

{说明编写这份用户手册的目的，指出预期的读者。

}

背景

{说明：

a．这份用户手册所描述的软件系统的名称；

b．该软件项目的任务提出者、开发者、用户〔或首批用户〕与安装此软件的的计算站中心。

定义

{列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

参考资料

{列出有用的参考资料，如：

a．本项目的经核准的计划任务书或合同、上级机关的批文；

b．属于本项目的其它已发表的文件；

c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

综述

统一的输入输出参数

Request

language

String

Y

:

中文，en:

英文，th：

泰文

uid

Int

用户ID.

sid

SessonId〔TOKEN〕

〔不需要登录就能调用的接口、注册接口、登录接口，uid和sid两个参数不需要输入〕

Response

succeed

0：

失败，1：

成功

error_code

N

错误码

error_desc

错误消息

必须登录才能访问的接口

接口名称

描述

user/signout

用户退出

user/photoupload

照片上传

user/changeprofile

修改用户资料

user/changepassword

修改用户密码

user/info

获取用户信息

错误返回码列表

1

授权过期

500

服务器内部错误

600

账号被锁定

10001

手机不能为空

10002

密码不能为空

10003

验证码不能为空

10004

平台类型不正确

10005

手机验证码不正确

10006

手机验证码已失效

10007

用户类型不正确

10008

用户名不能为空

10009

原密码不能为空

10010

新密码不能为空

10011

原密码不正确

10012

经度不能为空

10013

纬度不能为空

10014

对象用户ID不能为空

用户接口

用户注册〔user/signup〕

接口

user/signup

用户注册

验证

Session

方法

GET/POST

mobile

注册手机号.

verify_code

手机验证码

password

密码

platform

平台类型〔ios,android〕

用户ID

Example

{

"

verify_code"

"

123456"

password"

111111"

platform"

android"

succeed"

0,

error_code"

10006,

error_desc"

手机验证码已失效"

sid"

sess_573d27b370dc7"

uid"

28"

1

用户登录〔user/signin〕

user/signin

用户登录

注册手机号.（type=1时必须）

username

用户名（type=2、3、4时必须）

密码（type=1时必须）

type

用户类型

1：

手机号

2：

QQ

3：

微信

4：

微博

user

Array

用户信息

id

user_group

用户角色

普通用户

专车车主

nickname

昵称

email

name

某某

用户名

gender

性别

男

女

age

年龄

birthday

出生日期

avatar

头像URL

joined_at

注册时间

type"

1"

2003,

密码错误"

sess_573d285820a42"

user"

{

id"

3,

user_group"

1,

nickname"

test001"

email"

xiaoxiao163."

name"

王小二"

username"

:

gender"

age"

26,

birthday"

1985-10-10"

avatar"

/travel/public/uploadFile/avatar/empty.png"

joined_at"

2016-05-0310:

15:

53"

},

优惠券接口

我的优惠券〔coupon/mycoupon〕

coupon/mycoupon

我的优惠券