新浪接口.doc

个人代理人手机客户端接口定义文档
版本号
日期
作者
说明

2011-2
刘力峰
初稿;
修订控制页
编号
文档版本
修订章节
修订原因
修订日期
修订人
1
2
3
4
5
6
7
8
9
10
1概述

一起看电影的app主要功能是用户通过微博（以后或有其他）帐号登录，选择电影（服务端提供），用户选择通过微博API获得对象的好友，系统最后匹配，达成邀约的目的。
2接口规范协议

为了减少服务端与手机端的交互程度，减轻服务端压力，为用户节省流量，并同时提高用户交互体验。对于可离线使用的模块，采用在登录时或用户点击触发数据同步请求缓存到手机端，手机端自行存储同步后的数据。当数据同步完成后，用户打开功能模块时，调用本地已缓存的数据进行展示。对于即时或算法要求较高的模块则采用即时调用后台Http请求数据。
数据传输编码及请求编码均采用UTF-8格式。

采用标准HTTP方式POST进行请求。服务端与Web请求类似，自动取得参数进行解析。请求参数分为两种类型，一种是必须参数标识为required，，则采用有默认值。
返回数据格式
为了兼容多种终端系统平台，采用json通用格式进行返回结果。手机端自行解析并转换成可识别的数据。其中datatype为预留参数，可选参数，默认为json格式。目前只支持一种格式。
3接口设计

登录[remoteLogin:Service]
描述
手机端用微博登录成功后向服务端发送信息，其中用户第一次登陆时要获取用户关系数据，用户N久时间后的再次登录也会更新用户的关系数据。
接口定义
http://host:port/SeeMovieTogether /user/
手机端请求参数列表
Required
Name
Type
Description
required
username
string
登录的用户名
uid
AccountType
String
string
用户（微博）帐号唯一性编码
帐号类型，1微博2其它。目前只有1
optional
datatype
string
数据格式类型(取值：json,xml 默认json格式)
服务端返回参数列表
Name
Type
Description
IsUpInfo
Int
标识1或者0，1代表是第一次登陆或者需要更新用户关系数据的情况。0代表不需要获取用户数据。
success
boolean
成功标识(true:成功，false:失败)
errorMsg
string
错误消息，文字描述
Id
string
返回用户在本站的Id(32位主键)
serverTime
date
服务端时间(格式:yyyy-MM-dd HH:mm)
返回xml数据示例
{
“IsUpInfo”:1,
“success”:true,
“errorMsg”,
“Id”:11111222223333344444555556666622,
“serverTime”: 2011-02-17 18:00
}

描述
提示当服务端判断用户是第一次登陆或者时间太长需要更新用户关系数据时，上一步返回的标识为1，手机端发起本次请求。主要更新信息对象有本人的信息，本人关注的人的信息，本人粉丝的信息，三种类型。当用户关注集比较大的时候可以使用分页方式传输，例如每次传输100名用户的信息，不限次发送本请求。但是初期第一次一定要把本微博的互相关注用户传送过来。
接口定义
http://host:port/ SeeMovieTogether /user/
请求参数列表
Required
Name
Type
Description
required
Id
string
用户本站Id
optional
datatype
string
数据格式类型
用户信息
Name
Type
Description
uid
strin