web-intf – autofan-club

Context Navigation

Version 37 (modified by yangbo, 14 years ago) (diff)
--

汽车网车友汇项目接口

1. 基本约定

1.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。

2.当接口处理异常时，HTTP STATUS CODE 返回给500，并且给出具体的错误信息。
    {
	"uri" : "/intf/albums-by-type.jsp",
	"error-code":"20502",
	"error-desc":"Need you follow uid.",
        "user-notice":"给用户的提示放在这里"
    }

    
3.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部，实现类似下面的代码：

        String queryString = request.getQueryString();
        String requestEncoding = getParam(queryString,"req_enc");
        String responseEncoding = getParam(queryString,"resp_enc");
        if(isNotBlank(requestEncoding)){
            request.setCharacterEncoding(requestEncoding);
        }
        if(isNotBlank(responseEncoding)){
            response.setCharacterEncoding(responseEncoding);
        }

4.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。

5.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹，并且过滤掉回车换行，对字符串中包含的双引号(")进行转义；是数字类型时，不用引号。

6.本系统相关的周边系统有：互动核心平台（BIP）、公共帐号登录（PASSPORT）、图片上传中心（UPC），这些系统的测试环境配置可以参考 http://bbs.pconline.cn/topic-1894.html

2. 互动核心平台接口

互动核心平台会发布API包--bipClient.jar，这个jar会提供动态和系统消息的创建、系统消息的获取、动态的获取和关注的调用接口。

2.1 发送系统消息

1、接口地址

测试环境接口： http://192.168.74.8:1218/?name=httpsqs_master&opt=put

正式环境接口： http://queue.pconline.com.cn:1218/?name=httpsqs_master&opt=put

2、newsfeed 方法说明：

    public boolean newsfeed(long accountId,long typeId, Map<String,Object> contents){
    	
        if (accountId <= 0 || typeId <= 0 
                || contents == null || contents.isEmpty() 
                || ucServer ==null || queueServer.length() == 0) {
             return false;
        }

        String jsonContent = cacheParser.unparse(contents);
        
        Map<String,Object> msg = new HashMap<String,Object>(4);
        msg.put("act","create");
        msg.put("accountId", accountId);
        msg.put("typeId", typeId);
        msg.put("content", jsonContent);
        
        Map<String,Object> dataMap = new HashMap<String,Object>(3);
        dataMap.put("appName", "bip");
        dataMap.put("actionType", "createNewsfeed");
        dataMap.put("msg", msg);
        
        String data = cacheParser.unparse(dataMap);
        Map<String,Object> params = new HashMap<String,Object>(1);
        params.put("data", data);
        
        try {
            JsonResult json =  post(queueServer, params);
            return json.getCode()==0;
        } catch (Exception e) {
            JsonResult json = new JsonResult();
            json.setMessage(-1, e.getMessage());e.printStackTrace();
            return false;
        }
    }

sysnotice 方法说明

    public int sysnotice(long senderId,long accountId,long typeId, Map<String,Object> contents){

        if (accountId <= 0 || typeId <= 0 
                || contents == null || contents.isEmpty() 
                || queueServer ==null || queueServer.length() == 0) {
             return -1;
        }
        
        String jsonContent = cacheParser.unparse(contents);
        
        Map<String,Object> msg = new HashMap<String,Object>(3);
        msg.put("act","create");
        msg.put("accountId", accountId);
        msg.put("typeId", typeId);
        msg.put("content", jsonContent);
        msg.put("senderId", senderId);
        
        Map<String,Object> dataMap = new HashMap<String,Object>(2);
        dataMap.put("appName", "bip");
        dataMap.put("actionType", "createSysnotice");
        dataMap.put("msg", msg);
        
        String data = cacheParser.unparse(dataMap);
        Map<String,Object> params = new HashMap<String,Object>(3);
        params.put("data", data);
        
        try {
            JsonResult json =  post(queueServer, params);
            return json.getCode();
        } catch (Exception e) {
            JsonResult json = new JsonResult();
            json.setMessage(-1, e.getMessage());
            return -1;
        }
    }

2.2 获取系统消息

1、接口地址

测试环境接口： http://test748.pconline.com.cn:8083/intf/sysnotice.jsp

正式环境接口： http://bip.pconline.com.cn/intf/sysnotice.jsp

2、参数说明

            act         操作方式（查询：find；获得未读系统消息数量：getNum；）
            accountId   用户ID（取谁的系统消息）siteId	网站编号（全网：0；电脑网：1；汽车网：2；游戏网：3；女性网：4；亲子网：5；家居网：6）
            status      需要取什么状态的系统消息（全部：-1；未读：0；已读：1）
            groupType	需要取哪个组的系统消息（全部：-1；系统通知：0；好友请求：1；邀请消息：2；关注通知：3）
            pageNo	页码（第几页）（find 试用）
            pageSize	每页显示数量（find 试用）
            callback	回调
            result	find：JsonResult(bipClient.jar)(json)；getNum： int

2.3 更新系统消息状态

3. PASSPORT接口

3.1 登录接口

3.2 自动激活接口

3.3 辨认登录状态接口

4. BBS接口 -- 暂不实现

4.1 BBS发帖接口 -- 暂不实现

5. 车友会接口

5.1.1 创建活动

    URL：/intf/act-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *name：活动名称
              *start-date：开始时间(yyyy-mm-dd)
              *end-date：结束时间(yyyy-mm-dd)
              *detail：活动详情
              *area-id：地区编号        
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-id":2342,
     "name":"一起去海边",
     "start-date":"2012-03-18",
     "end-date":"2012-03-20",
     "detail":"活动详情，里面通常包括了手台信息",
     "area-id":233,
     "area-desc":"广东省/广州市"
    }
    返回参数说明：
        act-id：活动id
        name：活动名称
        start-date：开始日期（yyyy-mm-dd）
        end-date：结束日期（yyyy-mm-dd）
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
    排序方式：
        无

5.1.2 修改活动

    URL：/intf/act-update.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动id
              *name：活动名称
              *start-date：开始时间(yyyy-mm-dd)
              *end-date：结束时间(yyyy-mm-dd)
              *detail：活动详情
              *area-id：地区编号        
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-id":2342,
     "name":"一起去海边",
     "start-date":"2012-03-18",
     "end-date":"2012-03-20",
     "detail":"活动详情，里面通常包括了手台信息",
     "area-id":233,
     "area-desc":"广东省/广州市"
    }
    返回参数说明：
        act-id：活动id
        name：活动名称
        start-date：开始日期（yyyy-mm-dd）
        end-date：结束日期（yyyy-mm-dd）
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
    排序方式：
        无

5.1.3 更新活动状态

    URL：/intf/act-update-status.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动id
              *status：活动名称
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-id":2342,
     "uid":23233,
     "status":"一起去海边"
    }
    返回参数说明：
        act-id：活动id
        uid：用户ID
        status：活动状态：XXXXXXX ，start,runing,close,deleted
    排序方式：
        无

5.1.4 获取活动（行程、成员）

    URL：/intf/act-get.jsp
    HTTP请求方式：get
    是否需要登录：否
    提交参数：*act-ids：活动id，用逗号分隔（122,332,344）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"acts":[{"act-id":122,
              "name":"一起去海边",
              "start-date":"2012-03-18",
              "end-date":"2012-03-20",
              "detail":"活动详情，里面通常包括了手台信息",
              "area-id":233,
              "area-desc":"广东省/广州市",
              "created-by":"活动发起者",
              "creater-nickname":"大浪淘沙",
              "creater-mobile":"13932233232",
              "act-routes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232",
                             "addr":"广州市高普路","province":"广东","city":"广州","distict":"天河","type":"start","desc":""},
                           {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232",
                            "addr":"东莞市虎门","province":"广东","city":"东莞","distict":"虎门","type":"pass","desc":""},
                           {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232",
                            "addr":"深圳市八卦岭","province":"广东","city":"深圳","distict":"罗湖","type":"end","desc":""}],
              "act-member":[{"member-id":12232,"uid":232332,"type":"manager","mobile":"18933300984","license-plate":"粤A-23456"},
                            {"member-id":12233,"uid":234343,"type":"member","mobile":"18933300984","license-plate":""}]
             }
            ]
    }
    返回参数说明：
        act-id：活动编号
        name：活动名称
        start-date：开始日期(yyyy-mm-dd)
        end-date：结束日期(yyyy-mm-dd)
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
        created-by：活动创建者ID，这个ID是太平洋公共帐号ID。
        creater-nickname：创建者昵称，从个人资料中获取，冗余在结果里。
        creater-mobile：创建者手机，从个人资料中获取，冗余在结果里。
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度
        addr：地址说明
        province：省份
        city：城市
        distict：区/县
        type：行程类型：start,end,pass
        desc：描述
        member-id：活动成员编号
        uid：活动成员的太平洋公共帐号
        type：活动成员身份
        mobile：活动成员手机，默认从个人资料获取，网友可以在参加活动时修改
        license-plate：活动成员车牌，默认从个人资料获取，网友可以在参加活动时修改
    排序方式：
        1、按传入的act-id顺序排序
        2、按活动创建时间逆序

5.1.5 创建行程

    URL：/intf/act-route-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动id
              *routes：[{"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"广州市高普路","province":"广东","city":"广州","distict":"天河","type":"start","desc":""},
                       {"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"深圳市八卦岭","province":"广东","city":"深圳","distict":"罗湖","type":"end","desc":""}]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    { "act-id":122,
      "act-rountes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"广州市高普路","province":"广东","city":"广州","distict":"天河","type":"start","desc":""},
                    {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"东莞市虎门","province":"广东","city":"东莞","distict":"虎门","type":"pass","desc":""},
                    {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"深圳市八卦岭","province":"广东","city":"深圳","distict":"罗湖","type":"end","desc":""}]
    }
    返回参数说明：
        act-id：活动id
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度        
        addr：地址说明
        province：省份
        city：城市
        distict：区/县
        type：行程类型：start,end,pass
        desc：描述
    排序方式：
        1、按照seq顺序排列

5.1.6 修改行程

    URL：/intf/act-route-update.jsp， 采取删除/重建的方式来实现修改操作。
    HTTP请求方式：post
    是否需要登录：否
    提交参数：*common_session_id：登录后的session id
              *act-id：活动id
              *routes：[{"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"广州市高普路","province":"广东","city":"广州","distict":"天河","type":"start","desc":""},
                       {"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"深圳市八卦岭","province":"广东","city":"深圳","distict":"罗湖","type":"end","desc":""}]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    { "act-id":23232,
      "act-rountes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"广州市高普路","province":"广东","city":"广州","distict":"天河","type":"start","desc":""},
                    {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"东莞市虎门","province":"广东","city":"东莞","distict":"虎门","type":"pass","desc":""},
                    {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232",
                     "addr":"深圳市八卦岭","province":"广东","city":"深圳","distict":"罗湖","type":"end","desc":""}]
    }
    返回参数说明：
        act-id：活动ID
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度        
        addr：地址说明
        province：省份
        city：城市
        distict：区/县
        type：行程类型：start,end,pass
        desc：描述
    排序方式：
        1、按照seq顺序排列

5.1.7 活动报名

    URL：/intf/act-apply.jsp，报名成功后返回活动信息，方便应用处理。需要检查该用户是否参加了其他未结束的活动，并且活动的时间和现在想报名的时间冲突了。
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动ID
              *verify-str：活动验证密码
              *license-plate：车牌
              *mobile：手机
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-id":122,
     "name":"一起去海边",
     "start-date":"2012-03-18",
     "end-date":"2012-03-20",
     "verify-str":"下海去捞鱼",
     "detail":"活动详情，里面通常包括了手台信息",
     "area-id":233,
     "area-desc":"广东省/广州市",
     "created-by":"活动发起者",
     "creater-nickname":"大浪淘沙",
     "creater-mobile":"13932233232",
     "act-routes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                  {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"},
                  {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232"}],
     "act-member":[{"member-id":12232,"uid":232332,"type":"manager","mobile":"18933300984","license-plate":"粤A-23456"},
                   {"member-id":12233,"uid":234343,"type":"member","mobile":"18933300984","license-plate":""}]
    }
    返回参数说明：
        act-id：活动编号
        name：活动名称
        start-date：开始日期(yyyy-mm-dd)
        end-date：结束日期(yyyy-mm-dd)
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
        created-by：活动创建者ID，这个ID是太平洋公共帐号ID。
        creater-nickname：创建者昵称，从个人资料中获取，冗余在结果里。
        creater-mobile：创建者手机，从个人资料中获取，冗余在结果里。
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度
        member-id：活动成员编号
        uid：活动成员的太平洋公共帐号
        type：活动成员身份
        mobile：活动成员手机，默认从个人资料获取，网友可以在参加活动时修改
        license-plate：活动成员车牌，默认从个人资料获取，网友可以在参加活动时修改
    排序方式：
        无。

5.1.8 删除活动成员

    URL：/intf/act-member-del.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *uids：活动成员id，可以是一个或多个id，多个id之间用逗号（','）分隔，例如（2123,23434,434,343）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        [{"uid":232,"status":"success"},{"uid":353,"status":"fail"}]
    返回参数说明：
        uid：用户ID
        status：success成功、fail失败
    排序方式：
        无。

5.1.9 获取活动申请成员

    URL：/intf/act-member-apply-get.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动id
              page-no：分页页码
              page-size：单页数量
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        { "page-no":1,
          "page-size":20,
          "total":2,
          "applys":[{"uid":32322,"verify-str":"天王盖地虎","create-date":"yyyy-mm-dd hh:mi:ss"},
                   {"uid":32322,"verify-str":"天王盖地虎","create-date":"yyyy-mm-dd hh:mi:ss"}]}
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        uid：用户id
        verify-str：活动验证密码
        create-date：申请时间
    排序方式：
        1、按申请时间顺序排列

5.1.10 处理活动申请成员

    URL：/intf/act-member-apply-update.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动id
              *apply：[{"uid":23323,"action":"reject"},{"uid":2333,"action":"agree"}]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        [{"uid":1213,"status":"success"},{"uid":1213,"status":"fail"}]
    返回参数说明：
        uid：用户ID
        status：sucess：处理成功,fail：处理失败
    排序方式：
        无。

5.1.11 发表活动总结（记账）

    URL：/intf/act-pay-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *pays：[{"pay":332,"desc":"描述"},{"pay":332,"desc":"描述"}]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"pays":[{"id":233,"pay":4340,"desc":"住宿费用"},{"id":234,"pay":1340,"desc":"饭费"}]}
    返回参数说明：
        id：费用记录ID
        pay：费用
        desc：费用描述
    排序方式：
        无。

5.1.12 修改活动总结（记账）

    URL：/intf/act-pay-update.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *id：记账id
              *pay：金额
              *desc：描述
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"id":233,"pay-type":"住宿","pay":4340,"desc":"住宿费用"}
    返回参数说明：
        id：费用记录ID
        pay：费用
        desc：费用描述
    排序方式：
        无。

5.1.13 删除活动记账

    URL：/intf/act-pay-del.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *ids：记账id的集合，用逗号分隔不同的id，例如（233,323,323,323）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        无。
    排序方式：
        无。

5.1.14 上传活动图片

    URL：/intf/act-photo-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动ID
              *img-url：原图URL
              *img-url-middle：中图URL
              *img-url-small：小图URL
              desc：图片描述
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {  "act-id":2323,
           "img-id":434343,
           "img-url":"http://img.pconline.com.cn/2332.jpg",
           "img-url-middle":"http://img.pconline.com.cn/3233.jpg",
           "img-url-small":"http://img.pconline.com.cn/3232.jpg",
           "desc":"清晨宁静的海滩"}
    返回参数说明：
        act-id：活动ID
        img-id：图片ID
        img-url：图片URL
        img-url-middle：中图URL
        img-url-small：小图URL
        desc：图片描述
    排序方式：
        无。

5.2.1 创建用户

    URL：/intf/act-user-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *uid：用户ID，太平洋帐号
              nickname：用户昵称，从开放平台获取
              *face-url：用户头像
              *face-url-large：用户头像（大尺寸）
              *login-type：登录类型，（SINA,QZONE）
              *open-id：开放平台用户ID
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        无。
    排序方式：
        无。

5.2.2 修改用户资料

    URL：/intf/user-maintain.jsp，已经调用passport接口，创建了太平洋帐号后，再调用此接口来修改车友汇的用户。
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *uid：用户ID
              nickname：用户昵称
              *face-url：用户头像
              *face-url-large：用户头像（大尺寸）
              *login-type：登录类型，（SINA,QZONE）
              *open-id：开放平台用户ID
              mobile：手机
              license-plate：车牌号
              autoclubs：我关注的车友会，车友会ID，用逗号分隔(3323,3232,23,233)
              area-id：地区编号
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"uid":433443,
         "nickname":"上九天揽月",
         "face-url":"http://qlogo1.store.qq.com/qzone/7685620/7685620/50",
         "face-url-large":"http://qlogo1.store.qq.com/qzone/7685620/7685620/100",
         "login-type":"SINA",
         "open-id":23322332,
         "mobile":"13934443224",
         "license-plate":"粤A-32332",
         "autoclubs":[{"id":332,"name":"雷霆会","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"},
                      {"id":2332,"name":"车神汇","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"},
                      {"id":2332,"name":"改装会","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"}],
         "area-id":"10010",
         "area-desc":"广州"}
    返回参数说明：
        uid：太平洋公共帐号ID
        nickname：用户昵称
        face-url：头像URL
        face-url-large：头像URL，大尺寸
        login-type：登录类型（SINA,QZONE）
        open-id：开放平台用户ID
        mobile：手机
        license-plate：汽车牌照
        id：车友会编号
        name：车友会名称
        logo-url：车友会LOGO
        logo-url-large：车友会LOGO大图
        area-id：地区编号
        area-desc：地区名称
    排序方式：
      无。

5.2.3 获取用户资料

    URL：/intf/user-get.jsp，如果是获取本人资料，必须是登录状态才能获取。当不是获取的本人资料时，车牌号码和手机号需要进行保密处理。
    HTTP请求方式：get
    是否需要登录：否
    提交参数：*common_session_id：登录后的session id
              *uid:：用户ID
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"uid":433443,
         "nickname":"上九天揽月",
         "face-url":"http://qlogo1.store.qq.com/qzone/7685620/7685620/50",
         "face-url-large":"http://qlogo1.store.qq.com/qzone/7685620/7685620/100",
         "login-type":"SINA",
         "open-id":23322332,
         "mobile":"13934443224",
         "license-plate":"粤A-32332",
         "autoclubs":[{"id":332,"name":"雷霆会","logo-url":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"},
                      {"id":2332,"name":"车神汇","logo-url":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"},
                      {"id":2332,"name":"改装会","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"}],
         "area-id":"10010",
         "area-desc":"广州"}
    返回参数说明：
        uid：太平洋公共帐号ID
        nickname：用户昵称
        face-url：头像URL
        face-url-large：头像URL，大尺寸
        login-type：登录类型（SINA,QZONE）
        open-id：开放平台用户ID
        mobile：手机
        license-plate：汽车牌照
        id：车友会编号
        name：车友会名称
        logo-url：车友会LOGO
        logo-url-large：车友会LOGO大图
        area-id：地区编号
        area-desc：地区名称
    排序方式：
          无。

5.2.4 我参加的活动

    URL：/intf/user-act-get.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              page-no：分页页码，默认为1。
              page-size：分页数量，默认为10
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        { "page-no":1,
          "page-size":20,
          "total":4,         
          "uid":32233,
          "acts":[{"act-id":2323,"name":"明天去看海","create-date":"yyyy-mm-dd hh:mi"},
                  {"act-id":232,"name":"上山去打渔","create-date":"yyyy-mm-dd hh:mi"}]
        }
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        uid：用户ID
        act-id：活动id
        name：活动名称
        create-date：创建时间
    排序方式：
        1、按创建时间逆序

5.3.1 车友会查询

    URL：/intf/autofan-search.jsp
    HTTP请求方式：get
    是否需要登录：否
    提交参数：autofan-name：车友会名称，查询条件之一、可以支持模糊匹配。
              autofan-id：车友会编号，查询条件之一，能够精确查询车友会。
              page-no：分页页码
              page-size：分页数量              
              prefix：车友会名称的前缀（a-z）
              order-by：id-asc or name-asc 
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        { "page-no":1,
          "page-size":20,
          "total":4,
          "autufans":[{"id":22332,"name":"雷霆汇","prefix":"l","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"},
                      {"id":32342,"name":"雷霆汇","prefix":"l","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"}]
        }
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        id：车友会编号
        name：车友会名称
        prefix:车友会名称拼音的前缀
        logo-url：车友会LOGO
        logo-url-large：车友会LOGO大图
    排序方式：
        1、按id顺序
        2、按名称顺序

5.3.2 维护我关注的车友会

    URL：/intf/autufan-follow-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *uid:：用户ID
              *autofan-club-ids：我关注的车友会ID集合，用逗号区分各个车友会的ID，例如（323232,233232,2332233）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        { "uid":2332,
          "autufans":[{"id":22332,"name":"雷霆汇","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"},
                      {"id":32342,"name":"雷霆汇","logo":"http://img.autohome.com.cn/3232.jpg","logo-large":"http://img.autohome.com.cn/332.jpg"}]
        }
    返回参数说明：
        uid：太平洋公共帐号
        id：车友会编号
        name：车友会名称
        logo-url：车友会LOGO
        logo-url-large：车友会LOGO大图
    排序方式：
        按follow的时间顺序排列。

5.18 获取地区列表

XXXXXX

5.4.1 获取评论列表

    URL：/intf/act-comment-get.jsp
    HTTP请求方式：get
    是否需要登录：否
    提交参数：*img-id：图片ID
              page-no：分页页码
              page-size：单页数量
              order-by：create-date-asc , create-date-desc
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {  "page-no":1,
           "page-size":20,
           "total":5,
           "img-id":32323,
           "comments":[{"id":233,
                        "uid":2332,
                        "nickname":"上九天揽月",
                        "face-url":"http://qlogo1.store.qq.com/qzone/7685620/7685620/50",
                        "face-url-large":"http://qlogo1.store.qq.com/qzone/7685620/7685620/100",
                        "content":"绝美的风光",
                        "create-date":"2012-04-06 12:43"},
                       {"id":2335,
                        "uid":233232,
                        "nickname":"下五洋捉鳖",
                        "face-url":"http://qlogo1.store.qq.com/qzone/7685620/7685620/50",
                        "face-url-large":"http://qlogo1.store.qq.com/qzone/7685620/7685620/100",
                        "content":"清晨的海滩真是美不胜收",
                        "create-date":"2012-04-06 12:43"}
                       ]
        }
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        img-id:图片ID
        id：评论编号
        uid：太平洋公共帐号id
        nickname：用户昵称
        face-url：用户头像URL
        face-url-large：用户头像URL大图
        content：评论正文
        create-date：评论时间，yyyy-mm-dd hh:mi:ss 。
    排序方式：
        1、按评论创建时间顺序
        2、按评论创建时间逆序

5.4.2 发表评论

    URL：/intf/act-comment-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *img-id：图片ID
              *content：评论正文
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"id":233,  
         "img-id":23243,
         "nickname":"上九天揽月",
         "face-url":"http://qlogo1.store.qq.com/qzone/7685620/7685620/50",
         "face-url-large":"http://qlogo1.store.qq.com/qzone/7685620/7685620/100",
         "content":"绝美的风光",
         "create-date":"2012-04-06 12:43"}
    返回参数说明：
        id：评论编号
        img-id：图片ID
        uid：太平洋公共帐号id
        nickname：用户昵称
        face-url：用户头像URL
        face-url-large：用户头像URL大图
        content：评论正文
        create-date：评论时间，yyyy-mm-dd hh:mi:ss 。
    排序方式：
        无。

5.5.1 获取推荐活动列表

    URL：/intf/act-recommend.jsp
    HTTP请求方式：get
    是否需要登录：否
    提交参数：page-no：分页页码
              page-size：单页数量
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        { "page-no":1,
          "page-size":20,
          "total":2,
          "acts":[{"id":32323,
                    "name":"自驾去西藏",
                    "status":1,
                    "create-date":"yyyy-mm-dd",
                    "count-img":3,
                    "count-comment":4,
                    "act-img":[{"img-id":121,
                                "img-url":"http://img.pconline.com.cn/2332.jpg",
                                "img-url-middle":"http://img.pconline.com.cn/3232.jpg",
                                "img-url-small":"http://img.pconline.com.cn/32234.jpg",
                                "desc":"宁静的海滩"
                                },
                                {"img-id":121,
                                "img-url":"http://img.pconline.com.cn/2332.jpg",
                                "img-url-middle":"http://img.pconline.com.cn/3232.jpg",
                                "img-url-small":"http://img.pconline.com.cn/32234.jpg",
                                "desc":"宁静的海滩"
                                }
                              ]
                   },
                   {"id":3253,
                    "name":"海南自驾行",
                    "status":0,
                    "create-date":"yyyy-mm-dd",
                    "count-img":3,
                    "count-comment":4,
                    "act-img":[{"img-id":121,
                                "img-url":"http://img.pconline.com.cn/2332.jpg",
                                "img-url-middle":"http://img.pconline.com.cn/3232.jpg",
                                "img-url-small":"http://img.pconline.com.cn/32234.jpg",
                                "desc":"宁静的海滩"},
                                {"img-id":121,
                                "img-url":"http://img.pconline.com.cn/2332.jpg",
                                "img-url-middle":"http://img.pconline.com.cn/3232.jpg",
                                "img-url-small":"http://img.pconline.com.cn/32234.jpg",
                                "desc":"宁静的海滩"}
                              ]
                   }
                 ]
        }
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        id：活动ID
        name：活动名称
        status：活动状态
        create-date：活动创建日期(yyyy-mm-dd)
        count-img：活动图片数量
        count-comment：活动评论数量
        img-id：图片ID
        img-url：图片URL
        img-url-middle：中图URL
        img-url-small：小图URL
        desc：图片描述
    排序方式：
        1、按推荐时间逆序。

5.5.2 查询路书

    URL：/intf/act-search.jsp
    HTTP请求方式：get
    是否需要登录：否
    提交参数：kw：查询关键字
              club-id：查询条件，车友会ID
              area-id：查询条件，地区ID
              page-no：分页页码
              page-size：单页数量
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        { "page-no":1,
          "page-size":20,
          "total":2,
          "kw":"看海",
          "acts":[{"id":32323,
                    "name":"自驾去西藏",
                    "status":1},
                   {"id":3253,
                    "name":"海南自驾行",
                    "status":0}
                 ]
        }
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        kw：搜索关键词
        id：活动ID
        name：活动名称
        status：活动状态
    排序方式：
        1、按活动创建时间逆序

5.5.3 同车友会、同地区推荐

    URL：/intf/act-auto-match.jsp
    HTTP请求方式：get
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              club-ids：查询条件，车友会IDS,用逗号分隔。例如（323,3434,34343）
              area-id：查询条件，地区ID
              page-no：分页页码
              page-size：单页数量
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    返回参数：
        { "page-no":1,
          "page-size":20,
          "total":2,
          "kw":"看海",
          "acts":[{"id":32323,
                    "name":"自驾去西藏",
                    "status":1},
                   {"id":3253,
                    "name":"海南自驾行",
                    "status":0}
                 ]
        }
    返回参数说明：
        page-no：请求的页码，第一次为1。
        page-size：每个页面的记录数。
        total：这次查询的记录总数。
        kw：这个接口返回的kw参数为空，为了兼容查询接口。
        id：活动ID
        name：活动名称
        status：活动状态
    排序方式：
        1、按活动创建时间逆序

5.6.1 提交实际行程

    URL：/intf/act-route-post.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：*common_session_id：登录后的session id
              *act-id：活动ID
              *points：[{"lon":23.2332323,"lat":232.344434334},{"lon":23.2332323,"lat":232.344434334]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        无。
    返回参数说明：
        无。
    排序方式：
        无。

5.6.2 获取实际行程

    URL：/intf/act-route-get.jsp，此接口是返回队长的实际行程和队员的最新位置。
    HTTP请求方式：get
    是否需要登录：否
    提交参数：*act-id：活动id
              last-access-time：最后访问时间（这个是服务器时间，用来过滤实际行程的数据。）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"last-access-time":2332233,
         "uid":33223,
         "nickname":"上山打老虎",
         "lon":23.34434,
         "lat":124.34334,
         "real-route":[{"lon":23.2332323,"lat":232.344434334},{"lon":23.2332323,"lat":232.344434334}],
         "member":[{"uid":2333,"nickname":"Lucy是条鱼","lon":23.2332323,"lat":232.344434334},
                   {"uid":4353,"nickname":"Lucy是条鱼","lon":23.2332323,"lat":232.344434334}
                  ]
        }
    返回参数说明：
        last-access-time：本次访问的时间，这个时间要从数据库服务器获取。
        uid：用户id
        nickname：昵称
        lon：经度
        lat：纬度        
    排序方式：
        1、队长的实际行程，按照时间顺序排列。

6. Error Code

error code

7. 修改历史

2012-03-12

-修改5.5.1接口，增加活动创建时间、活动图片数量和活动评论数量3个属性

2012-03-08

-修改5.1.7接口的返回参数形式，这里实际是返回报名成功的那个活动。

2012-03-05

-修改5.2.2，5.2.3两个接口的描述，修改5.2.4接口提交参数的默认值。

2012-02-28

-增加Error Code

2012-02-27

-修改提交参数的必填输入

-修改提交参数中日期类型的格式

2012-02-24:

-新增5.6.1提交实际行程接口

-新增5.6.2获取实际行程接口

2012-02-22:

-整理接口编号

-新增5.5.3 同车友会、同地区推荐接口

-补充5.1.7 活动报名接口的实现规则，增加活动时间冲突时的约束。

2012-02-20:

-发布基本版本接口

Download in other formats:

Plain Text

Context Navigation

汽车网车友汇项目接口

目录

1. 基本约定

2. 互动核心平台接口

2.1 发送系统消息

2.2 获取系统消息

2.3 更新系统消息状态

3. PASSPORT接口

3.1 登录接口

3.2 自动激活接口

3.3 辨认登录状态接口

4. BBS接口 -- 暂不实现

4.1 BBS发帖接口 -- 暂不实现

5. 车友会接口

5.1.1 创建活动

5.1.2 修改活动

5.1.3 更新活动状态

5.1.4 获取活动（行程、成员）

5.1.5 创建行程

5.1.6 修改行程

5.1.7 活动报名

5.1.8 删除活动成员

5.1.9 获取活动申请成员

5.1.10 处理活动申请成员

5.1.11 发表活动总结（记账）

5.1.12 修改活动总结（记账）

5.1.13 删除活动记账

5.1.14 上传活动图片

5.2.1 创建用户

5.2.2 修改用户资料

5.2.3 获取用户资料

5.2.4 我参加的活动

5.3.1 车友会查询

5.3.2 维护我关注的车友会

5.18 获取地区列表

5.4.1 获取评论列表

5.4.2 发表评论

5.5.1 获取推荐活动列表

5.5.2 查询路书

5.5.3 同车友会、同地区推荐

5.6.1 提交实际行程

5.6.2 获取实际行程

6. Error Code

7. 修改历史

Download in other formats: