oto餐饮app和服务器通信接口和规范定义(三)

一、协议

     采用短链接的http协议进行通讯,提交方式为post和get两种方式，返回的数据类型为JSON

     1.1 公共头部

   所有接口请求均包含以下头信息(Http Request Header)

 

参数名称

类型

是否必须

参数值示例

说明

appkey

String

Y

Md5

软件身份key

udid

String

Y

udid or imei

手机客户端的唯一标识  *#06#

os

String

Y

Iphone os

操作系统名称

osversion

String

Y

5.0

操作系统版本

appversion

String

Y

1.0.0

APP版本

sourceid

String

Y

Google Play

推广ID

ver

String

Y

0.9

通讯协议版本

userid

String

N

12345

用户ID

usersession

String

N

Cbaq4fxvb

登陆后得到的用户唯一性标识

unique

String

N

xvbvsfsgdsg

激活后得到的设备唯一性标识

 

  所有通信均无加解密信息，参数解释：

  appkey         身份标识，服务器端进行识别

  udid              客户端硬件标识

  os                  ios& android& WM7

  osversion      5.0

  appversion    app发布版本

  sourceid       

  ver

  userid           登录完之后传客户端

  usersession   登录标识

  unique          app自动激活后服务器返回标识

  1.2  一些规范

      a     错误码返回格式：

        {

           "response": "error",

           "error": {

          "text": "用户名不存在"

         } 

        }

      b     type类型：

    

type

description

1

2

3

4

5

     c     排序

     d     菜单列表

     e     请求类型：

       一般情况下

       抓取数据的请求，皆为GET

       和服务器有交互的请求，皆为POST

二、接口定义

      2.1  cmyy app 接口定义

         初定请求host为http://192.168.1.4:8080/cmyy/   192.168.1.4为域名或者测试ip地址

            2.1.1 登录

发送方式

发送URL

备注

GET

login!login.action?userName=&userPwd=

 

参数名称

描述

样例

无

 

 

服务器返回数据

描述

样例

 

模块

登录

{"bussinessId":0,"cityId":0,"createTime":1328311801,"email":"","id":"45","isEffect":1,"level":0,"loginCount":0,"loginIp":"127.0.0.1","loginTime":1328312741,"mobile":"","score":0,"sex":-1,"totalShop":0,"updateTime":null,"userName":"111","userPwd":"698D51A19D8A121CE581499D7B701668"}

    2.1.2 请求外卖店家

发送方式

发送URL

备注

GET

bussiness!queryBussiness.action?city=1&page=1

参数名称

描述

样例

无

 

 

服务器返回数据

描述

样例

 

请求外卖店家

[{"address":"上海市浦东","btakeaway":1,"caiType":"西餐","createTime":0,"id":1,"level":5,"logoName":"tongfu.jpg","name":"同福客栈","payPer":100,"phone":"","workEnd":9,"workStart":21},{"address":"北京","btakeaway":2,"caiType":"中餐","createTime":0,"id":2,"level":4,"logoName":"cmyy.jpg","name":"柴米油盐","payPer":1000,"phone":"","workEnd":2,"workStart":2},{"address":"南昌","btakeaway":1,"caiType":"中餐","createTime":0,"id":3,"level":4,"logoName":"qiao.jpg","name":"俏江南","payPer":200,"phone":"","workEnd":1,"workStart":1},{"address":"深圳","btakeaway":1,"caiType":"西餐","createTime":0,"id":4,"level":5,"logoName":"ken.jpg","name":"肯德基","payPer":300,"phone":"","workEnd":1,"workStart":1},{"address":"重庆","btakeaway":1,"caiType":"中餐","createTime":0,"id":5,"level":6,"logoName":"hao.jpg","name":"好粥到","payPer":25,"phone":"","workEnd":1,"workStart":1},{"address":"武汉","btakeaway":1,"caiType":"西餐","createTime":0,"id":6,"level":2,"logoName":"bi.jpg","name":"必胜客","payPer":400,"phone":"","workEnd":1,"workStart":1},{"address":"长沙","btakeaway":1,"caiType":"中餐","createTime":0,"id":7,"level":3,"logoName":"sha.jpg","name":"沙县小吃","payPer":7,"phone":"","workEnd":1,"workStart":1}]

   2.1.3 请求店家菜单

未完.....