Authored by 周蓉君

新增注册设备接口文档。Review by 石祥。

Showing 1 changed file with 69 additions and 0 deletions
  1 +# rd(Register Device)
  2 +
  3 +## 接口名称
  4 +
  5 +
  6 +## URL
  7 + * http://union.yoho.cn/union/UnionRest/xxxx
  8 +
  9 +
  10 +## 支持格式
  11 +JSON
  12 +
  13 +## HTTP请求方式
  14 +POST
  15 +
  16 +## 请求参数
  17 +**参数列表:**
  18 +
  19 +| 字段 | 描述 | 类型 | 示例 |
  20 +|------------|--------|--------|----------------------|
  21 +| client_type | 用户手机系统:Android,IOS | string | Android/iPhone |
  22 +| udid | 设备唯一码 | string | eca7c8cad3f1ba8e6228a4f682c85f961ce1b02a |
  23 +| idfa | 广告标识符 | string | E6F8BEC8-2261-4345-B028-A8C8EFC34C7D |
  24 +| imei | android设备号 | string | E6F8BEC8-2261-4345-B028-A8C8EFC34C7D |
  25 +| client_secret | 客户端加密 | string | 35eab5946cc46b86bc269603aee95971 |
  26 +
  27 +**JSON格式:**
  28 +```
  29 +{
  30 + "idfa": "E6F8BEC8-2261-4345-B028-A8C8EFC34C7D",
  31 + "udid":"eca7c8cad3f1ba8e6228a4f682c85f961ce1b02a",
  32 + "client_type":"iPhone",
  33 + "client_secret":"35eab5946cc46b86bc269603aee95971"
  34 +}
  35 +
  36 +{
  37 + "imei": "E6F8BEC8-2261-4345-B028-A8C8EFC34C7D",
  38 + "udid":"eca7c8cad3f1ba8e6228a4f682c85f961ce1b02a",
  39 + "client_type":"Android",
  40 + "client_secret":"35eab5946cc46b86bc269603aee95971"
  41 +}
  42 +```
  43 +
  44 +## 返回字段说明
  45 +**返回列表:**
  46 +
  47 +| 字段 | 描述 | 类型 | 示例 |
  48 +|------------|--------|--------|----------------------|
  49 +| code| 返回的code, 200, 304等,具体的服务器定义 | int | |
  50 +| message | 信息 | string | |
  51 +| md5 | 当前请求的唯一码 | string | |
  52 +| data | 配置参数数据,参考data列表 | object | |
  53 +
  54 +**列表:**
  55 +
  56 +| 字段 | 描述 | 类型 | 示例 |
  57 +|------------|--------|--------|----------------------|
  58 +
  59 +**JSON格式:**
  60 +```
  61 +{
  62 +"code":200,
  63 +"message":"Register Success",
  64 +"md5":"1231231231231",
  65 +"data":{
  66 +
  67 + }
  68 +}
  69 +```