我爱家乡手机端接口文档4 3

1、我爱家乡手机端调用文档版本修订历史修订时间修订人员版本目录目录2一、文档书写背景:3二、服务器地址3三、通讯协议3四、token说明3五、POI有关接口3接口_标记POI(100)3接口_请求POI说明内容(101)3接口_获取POI列表(102)4接口_获取POI评论列表(103)5接口_用户提交POI评论(104)5接口_删除POI(105)7接口_删除POI评论(106)7接口_请求POI评论图片(107)7六、BLESS有关接口7接口_获取祝福列表(200)7接口_提交祝福语(201)8接口_提交祝福评论(202)_没用8接口_删除祝福语(203)9接口_删除祝福评论(204)_没用9

2、七、统计接口9接口_城市祝福总量排名(300)9八、城市有关接口:11接口_查询城市列表citycode(500)11九、其它相关接口:11接口_查询城市citycode(401)_没用11分配USERID接口(402)12用户反馈接口(403)12Notification接口(404)12十、mescode说明12一、文档书写背景:为我爱手机家乡手机客户端提供祝福和POI点引用接口。二、服务器地址通讯格式:http:/服务器地址/hometown?busicode=busicode服务器地址: 87:18080/ihometownwebbusicode是必需参数，是服务器

3、处理业务的分类码。每个接口都有一个唯一的busicode，busicode参数一定要加在服务器地址的后面。三、通讯协议(1) 协议：HTTP:POST enctype: application/x-www-form-urlencoded(2)request参数(小写)：urlencoding utf8 编码(3) response数据格式：JSONresponse的其本的数据格式： “mescode”:”信息码”,”mes”:”信息说明”,名称说明备注mescode信息码必需mes信息说明必需四、token说明每个接口的访问token为:”密码+服务器token”的md5码。服务器token:

4、 d3b09f5d22a257b9158368891ecdd803密码：手机用户第一次使用软件时，请调用402接口，分配一个用户ID,分配用户ID时请手机端传入一个密码，此密码为token拼接时的密码，此用户ID为手机端的唯一标识,，请将用户ID和密码存保存起来。五、POI有关接口接口_标记POI(100)request参数：名称说明备注buscode100业务码title标题必需content说明内容必需userid用户ID，如果没有填”必需username昵称必需longitude经度必需latitude纬度必需citycode城市编码必需token访问token必需mapzoomleve

5、地图放大级别必需response数据： “mescode”:信息码,”mes”:”信息说明”,”poiid”:刚插入的poiid接口_请求POI说明内容(101)request参数：名称说明备注buscode101业务码idpoi点唯一编码必需token分配的token必需mtype媒体类型1:背影女声必需userid用户ID，如果没有填”必需citycode城市唯一编码必需response数据： “mescode”:信息码,”mes”:”信息说明”,”poi”:“id”:222,”title”:”昆山”,”content”:”美丽家乡”,”murl”:”http:/xxx?xxxx.mp3”

6、,”userid”,用户ID,”username”:”用户姓名”接口_获取POI列表(102)request请求参数：名称说明备注buscode102业务码citycode城市编码必需userid用户编码必需type0:自已标注的1:系统的2:所有的（不分用户含系统和所有用户，返回列表中系统的会排在最前面，用户的排后面）必需count每次请求的数量必需page当前请求页数必需token访问token必需response数据：名称说明备注longitude经度必需latitude纬度必需textreplysum文本评论数量必需imgreplysum图片评论数量必需idPOI唯一编号必需issys

7、tem是不是系统的POI必需status状态0:可见,1:不可见,3:删除必需title标题必需simdesc简单说明必需page当前页mescode=0时存在mapzoomleve地图放大级别必需poisortpoi分类必需数据格式： “mescode”:信息码,”mes”:”信息说明”,”page”:1,”list”:“id”:”222222”,“title”:”大熊的窝”, “longitude”:1000, “userid“:22,”username”:”小明”,”latitude” :3333,”textreplysum”:50,”imgreplysum”:200,”issystem

8、”:0,”status”:0,”simdesc”:”我的家乡”,”mapzoomleve”:地图放大级别,”poisort”:”poi分类”接口_获取POI评论列表(103)request参数：名称说明备注buscode103业务码poiidpoi点的唯一编码必需citycode每次请求的数量必需userid用户ID，如果没有填必需type0:userid对应的评论1:所有评论必需page当前请求页数必需token访问token必需count每次请求的条数必需response数据：名称说明备注id评论的唯一编码必需username昵称必需type0:文本1:图片必需content0:文本评论1

9、:图片地址必需time评论的时间必需page当前请求页mescode=0时存在 “mescode”:信息码,”mes”:”信息说明”,”page”:1,”list”:“id”:222222,“username”:”小明”, “type”:1, “content” :”86/b.jpg”,”time”:”2012-04-05”，“id”:222222,“username”:”鬼吹灯”, “type”:0, “content” :”瞎吹，破地方没什么意思。”,”time”:”2012-04-05”接口_用户提交POI评论(104)http协议:POST enctyp

10、e: multipart/form-dataheader参数:名称说明备注connectionkeep-alive必需content-typemultipart/form-data;boundary=自定义boundary必需request参数(所有参数都urlencoding utf-8然后再拼串：名称说明备注buscode104业务码type0:文本1:图片必需content文本评论内容type=0时必需citycode城市编码必需userid用户id必需username昵称必需poiidpoiid唯一编码必需token访问token必需请求的数据格式采用http协议:POST encty

11、pe: multipart/form-data进行封装. 分隔符: -自定义boundary 前面的-不可以省略数据封装格式如下(换行用n代替,分隔符必需是一行，如果是图片，图片部份可以省略)：分隔符Content-Disposition: form-data; name=useriduserid内容分隔符Content-Disposition: form-data; name=usernameusername内容分隔符Content-Disposition: form-data; name=poiidpoiid内容分隔符Content-Disposition: form-data; name

12、=typetype内容分隔符Content-Disposition: form-data; name=contentcontent分隔符Content-Disposition: form-data; name=citycodecitycode内容分隔符Content-Disposition: form-data; name=tokentoken内容分隔符Content-Disposition: form-data; name=image; filename=photo.jpgContent-Type: image/jpeg图片文件数据流分隔符-response数据： “mescode”:”信息

13、码”,”mes”:”信息说明”接口_删除POI(105)request参数：名称说明备注buscode105业务码idpoi的唯一Id必需citycode城市编号必需token访问token必需useriduserid必需response数据： “mescode”:信息码,”mes”:”信息说明”接口_删除POI评论(106)request参数：名称说明备注buscode106业务码id评论编号必需poiidpoi唯一编码必需citycode城市编号必需token访问token必需userid用户编号必需response数据： “mescode”:信息码,”mes”:”信息说明”接口_请求PO

14、I评论图片(107)post、get请求都可以post请求请在http头中加入: Proxy-Connection=Keep-Aliverequest参数：名称说明备注buscode107业务码image103接中返回信息中type=1时的content必需type0:小图,1:大图必需response：二进制图片数据流六、BLESS有关接口接口_获取祝福列表(200)request参数：名称说明备注buscode200业务码city关于城市查询内容必需count每次请请多少条必需userid用户id必需type0:自已的1:citycode的所有祝福2:citycode推荐祝福必需ftype

15、0:city填citycode1:city填城市名称page当前请求页数必需token访问token必需response数据：名称说明备注content内容必需time时间必需username用户昵称必需id祝福唯一编号0:无必需page当前页mescode=0时存在replyof009009回复语必需promotion推广信息必需 “mescode”:信息码,”mes”:”信息说明”,”page”:1,”list”:“id“:900, “content”:”家乡很美”, “time”:”2012-03-06”,username:”小明”,”replyof009”:”009回复语”,”prom

16、otion“:”推广信息”接口_提交祝福语(201)request参数：名称说明备注buscode201业务码type0:文本必需content内容必需citycode城市编码必需userid用户ID必需username用户昵称必需token访问token必需share0:不分享 1:分享必需longitude径度必需latitude纬度必需response数据： “mescode”:信息码,”mes”:”信息说明”,”blesssum”:城市总祝福量,”order”:全国祝福指数排名,”replyof009”:”009回复” 接口_提交祝福评论(202)_没用request参数：名称说明备注

17、buscode202业务码blessid祝福维一编码必需citycode城市编号必需token分配的token必需content评论内容必需username昵称必需userid用户编号必需response数据： “mescode”:信息码,”mes”:”信息说明”接口_删除祝福语(203)request参数：名称说明备注buscode203业务码id祝福语编号必需citycode城市编号必需token分配的token必需userid用户编号必需response数据： “mescode”:信息码,”mes”:”信息说明”接口_删除祝福评论(204)_没用request参数：名称说明备注busco

18、de204业务码id评论ID必需blessid祝福唯一编码必需citycode城市编号必需token访问token必需userid用户编号必需response数据： “mescode”:信息码,”mes”:”信息说明”七、统计接口统计接口中省的数据只能和数进行比较，市数据和市数据进行比较时含（直辖市和特别行政区）接口_城市祝福总量排名(300)祝福指数:祝福总次数/万人所有查询必需参数：名称说明备注buscode300业务码token访问token必需userid分配的用户id必需type1:全国祝福指数排名VS2:同行政级城市祝福指数VS3:同级人口城市祝福指数VS4:同行政区5:单日内历史

19、内最高统计6:不同城市祝福指数VS必需type:1、2、3时:request需加参数:city城市名称必需ftype0:城市编码查进行查询,city填城市编码1:城市名称进行查询,city填城市名必需fcount显示前多少条排名必需bcount显示后多少条排名response(type1,2,3,4)数据:“messcode”:信息码,”mes”:”信息说明”,”text”:”地理内容”,”list”:“citycode”:城市编码,”city”:城市名称,”blesssum”:祝福总数,”blessindex”:”祝福指数”,”order”:名次,”highlight”:1,”indexun

20、it”:”祝指数单位”type:4时:reqeust需加参数:countryarea查询条条件必需ftype0:行政区编号查询1:行政区名称查询必需count查询条数必需response数据:“messcode”:信息码,”mes”:”信息说明”,”list”:“citycode”:城市编码,”city”:城市名称,”blesssum”:祝福总数,”blessindex”:”祝福指数”,”order”:名次,” indexunit”:” 祝指数单位”type:5时:request需加参数:city城市名称必需ftype0:城市编码查进行查询,city填城市编码1:城市名称进行查询,city填城

21、市名必需fcount显示前多少条排名必需bcount显示后多少条排名reponse数据:“messcode”:信息码,”mes”:”信息说明”,”list”:“citycode”:城市编码,”city”:城市名称,”blesssum”:祝福总数,”hblesssumday”:日最高祝福总数,”blessindex”:”祝福指数”,”order”:名次,”time”:”2012-04-25 10:00:00”,” highlight “:1,” indexunit”:” 祝指数单位”type:6时:request参数:ftype0:城市编码查进行查询,city填城市编码1:城市名称进行查询,ci

22、ty填城市名必需city格式:index=201|city=上海&index=203|city=上海index和name对应的值也要urlencoding utf-8,所有值全部urlencoding utf-8ftype为0时city为城市编号ftype为1时city为城市名称查询必需 index对应的值自已定义，作用只是区分是那个城市的内容最多两个reponse数据:“messcode”:信息码,”mes”:”信息说明”,”list”:“index”:201,“citycode”:城市编码,”city”:城市名称,”blesssum”:祝福总数,”blessindex”:祝福指数,”ord

23、er”:名次,”text”:”上海你好”，”population”:23000,”hisblesssum”:“month”:”月份”,”mbindex”:”月幸福指数”,“index”:203,“citycode”:城市编码,”city”:城市名称,”blesssum”:祝福总数,”blessindex”:”祝福指数”,”order”:名次,”text”:”北京您好”,”population”:2344444, “hisblesssum”: “month”:”月份”,” mbindex”: :”月幸福指数”,” indexunit”:”幸福指数单位”接口_客户端统计首页(301)request

24、参数：名称说明备注buscode301业务码token访问token必需userid用户ID必需response数据:“miscode”:信息码,”mes”:”信息说明”,”tpoisum”:总位置添加量,”treplysym”:总评论次数,”timagesum”:总图片添加量,”tusersum”:使用总人数 八、城市有关接口:接口_查询城市列表(500)request参数：名称说明备注buscode500业务码token访问token必需city查询城市必需ftype0:city填城市编码1:city填城市名称必需userid用户ID必需level查询以下级数:最小级 默认会查所有级别非必

25、需resonse数据：mescode:信息码,mes:信息说明,”areacode”:”区域编码”,list:citycode:城市编号,mapzoomleve:地图放大级别,children:citycode:城市编号,mapzoomleve:地图放大级别,children:,longitude:经度,latitude:纬度,cityname:城市名称,longitude:径度,latitude:纬度,cityname:城市名称备注：areacode只会在省份的情况下出现,如果查询city为省的话areacode会出现在mescode 一层。接口_查询城市地理文化内容(501)request

26、参数：名称说明备注buscode501业务码token访问token必需city查询城市必需ftype0:city填城市编码1:city填城市名称必需userid用户ID必需resonse数据：mescode:信息码,mes:信息说明,”city”:”gtext”:”地理文化信息”九、其它相关接口:接口_查询城市citycode(401)_没用request参数：名称说明备注buscode401业务码token访问token必需query查询串:c1=urlencoding(cityname,”utf-8”)&2=c1=urlencoding(cityname,”utf-8”)必需response数据： “mescode”:信息码,”mes”:”信息说明”,”citycode”:“c1”:”345”,“c2”:null查不到citycod