5G 数据中台开放接口

1.1 激活 5G 服务

1.2 注销 5G 服务

1.3 同步用户信息（包含开通状态）

1.4 数据源标准 API

1.5 移动物联网方案默认数据源标准API

1.6 移动物联网相关接口

1.6.1 校园身份查询

1.6.2 移动物联网实时给 SID 同步开通信息

1.7 AAA相关接口

1.7.1 获取用户类型对应 IP 池的配置

1.7.2 获取不允许接入的IP段

1.8 错误代码说明

说明

appid和securityId为不同运营商的应用参数，由工程师提供给运营商。

例如中移物联网运营商，选择5G中移物联网，进入单点登录配置，将应用ID(appid)，应用密钥(securityId)复制出来提供给运营商。 注意：不同的运营商appid和securityId的值是不一样的。

1.1 激活 5G 服务

请求地址:

请求地址(多域名): https://self.xxxx.com.cn/data-sync/public/network/open/{appId}

请求地址(单域名): https://sso.xxxx.com.cn/{定义路径按需}/gate/data-sync/public/network/open/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明: 激活用户 5G 服务，请求地址由项目工程师提供

请求头:

请求参数:

返回参数:

请求实例:

请求头：

Authorization : Bearer md5(appId+securityId)

请求体：

{
"XM": "测试账号",
"IDCARD": "123123456789",
"TEL": "15711598999",
"SFLBDM": "05",
"SFZJLXM": "Z"
}

响应实例:

{
"code": 200,
"message": "OK",
"data": true
}

响应失败实例:

{
  "code": 412,
   "message": "Precondition Failed",
    "data": {
    "errorCode": 1000009,
    "errorMessage": "用户已经开通5G校园网"
    }
}

1.2 注销 5G 服务

请求地址:

请求地址(多域名): https://self.xxxx.com.cn/data-sync/public/network/cancel/{appId}

请求地址(单域名): https://sso.xxxx.com.cn/{定义路径按需}/gate/data-sync/public/network/cancel/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明: 注销用户 5G 服务，请求地址由项目工程师提供

请求头:

请求参数:

返回参数:

请求实例:

请求头：

Authorization : Bearer md5(appId+securityId)

请求体：

{
"XM": "测试账号",
"IDCARD": "123123456789",
"TEL": "15711598999",
"SFLBDM": "05",
"SFZJLXM": "Z"
}

响应实例:

{
"code": 200,
"message": "OK",
"data": true
}

响应失败实例:

{
  "code": 412,
  "message": "Precondition Failed",
  "data": {
    "errorCode": 10000094,
    "errorMessage": "用户已注销"
  }
}

1.3 同步用户信息（包含开通状态）

请求地址:

请求地址(多域名): https://self.xxxx.com.cn/data-sync/public/network/search/{appId}

请求地址(单域名): https://sso.xxxx.com.cn/{定义路径按需}/gate/data-sync/public/network/search/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明: 同步获取当前用户的开通信息，手机号，开通状态，失败原因，请求地址由项目工程师提供

请求头:

请求参数:

返回参数:

请求实例:

请求头：

Authorization : Bearer md5(appId+securityId)

请求体：

{
  "pageSize": 10, //每页数据，最大值3000每页
  "currentPage": 1 // 查询第几页
}

响应实例:

// 查询开通5G业务的用户列表
{
  "code": "200", // 请求状态码, 200请求成功，
  "message": "OK", // “OK”
  "data": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPages": 2,
    "totalAmount": 20,
    "results": [ // 可配置
      {
        "TEL": "xxx",
        "WLANSTATUS": "xx", //当前只有 1
        "REASON":"xxxx" // 预留字段，失败原因
      }
    ]
  }
}
// 查询不存在
{
  "code": 204, // 204
  "message": "No Content",
  "data": null
}
// 业务异常
{
  "code": "412", // 412参数错误
  "message": "Precondition Failed",
  "data": {
    "errorCode": "xxx", // 更多错误码见附件
    "errorMessage": "xxxx"
  }
}

1.4 数据源标准 API

请求地址: https://xxx.xxxx.xxx.xx/xxx

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明: 适用于数据中心API对接，查询数据源用户，请求地址由数据中心按照该接口开发后提供

请求头:

请求参数:

注：TEL 与 IDCARD 可同时查或者单独查询，视对端业务考虑。

返回参数:

响应实例:

{
  "code": "200", // 请求状态码, 200请求成功，
  "message": "OK", // “OK”
  "data": [
    {
      "XGH": "JZG001",
      "XM": "测试账号",
      "IDCARD": "123123456789",
      "TEL": "15711598999",
      "SFLBDM": "05",
      "SFZJLXM": "Z",
      "ZT": "1"
    }
  ]
}

1.5 移动物联网方案默认数据源标准API

请求地址: https://xxx.xxxx.xxx.xx/xxx

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明: 查询数据源用户。对接中移物联网方案专属接口(入参为学工号)，内置的身份信息源“中移物联网”中，调用该接口，请求地址由数据中心按照该接口开发后提供。

请求头:

请求参数:

返回参数:

响应实例:

{
  "code": "200", // 请求状态码, 200请求成功，
  "message": "OK", // “OK”
  "data": [
    {
      "XGH": "JZG001",
      "XM": "测试账号",
      "IDCARD": "123123456789",
      "TEL": "15711598999",
      "SFLBDM": "05",
      "SFZJLXM": "Z",
      "ZT": "1"
    }
  ]
}

1.6 移动物联网相关接口

1.6.1 校园身份查询

请求地址:

请求地址(多域名): https://self.xxxx.xxx.xx/data-sync/public/network/search/userInfo/{appId}

请求地址(单域名): https://sso.xxxx.xxx.xx/{定义路径按需}/gate/data-sync/public/network/search/userInfo/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明:

查询身份信息源的用户数据，用于中移物联网方案，提供给对方进行调用查询, 请求地址由项目工程师提供

请求头:

请求参数:

返回参数:

请求实例: 请求头：

Authorization : Bearer md5(appId+securityId)

请求体：

{
"XGH" : "12345678"
}

响应实例:

// 查询用户信息数据
{
  "code": 200,
  "message": "OK",
  "data": {
    "XGH": "123",
    "XM": "张三", //姓名
    "SFLBDM": "01", //身份类别代码
    "SFZJLXM": "1", //身份证件类型码
    "IDCARD": "321011198509191919", //身份证件号
    "TEL": "15252543987" //手机号
  }
}

// 查询不存在
{
  "code": 204, // 204
  "message": "No Content",
  "data": null
}
// 业务异常
{
  "code": "412", // 412参数错误
  "message": "Precondition Failed",
  "data": {
    "errorCode": "xxx", // 更多错误码见附件
    "errorMessage": "xxxx"
  }
}

1.6.2 移动物联网实时给 SID 同步开通信息

请求地址:

请求地址(多域名): https://self.xxxx.xxx.xx/data-sync/public/network/syncUserResult/v2/{appId}

请求地址(单域名): https://sso.xxxx.xxx.xx/{定义路径按需}/gate/data-sync/public/network/syncUserResult/v2/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明:

移动同步用户的开通结果，用于中移物联网方案，提供给对方进行调用同步开通结果，请求地址由项目工程师提供

请求头:

请求参数:

返回参数:

请求实例: 请求头：

Authorization : Bearer md5(appId+securityId)

请求体：

[
  {
    "XGH": "12345678",
    "TEL": "15252543987"
  },
  {
    "XGH": "123456789",
    "TEL": "15252543985"
  }
]

响应实例:

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "XGH": "12345678",
      "status": "success",
      "IPv4": "192.168.0.1",
      "IPv6": null //字段预留，后续支持
    },
    {
      "XGH": "123456789",
      "status": "failure",
      "message": "该用户已注册过手机号码，请更换手机号码再进行注册。",
      "IPv4": null,
      "IPv6": null //字段预留，后续支持
    }
  ]
}

1.7 AAA相关接口

1.7.1 获取用户类型对应 IP 池的配置

请求地址:

请求地址(多域名): https://self.xxxx.xxx.xx/data-sync/public/network/5g/config/ipPool/byCategory/{appId}

请求地址(单域名): https://sso.xxxx.xxx.xx/{定义路径按需}/gate/data-sync/public/network/5g/config/ipPool/byCategory/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明:

查询用户类型对应 IP 池的配置，请求地址由项目工程师提供

请求头:

请求参数:

无

返回参数:

请求实例: 请求头：

Authorization : Bearer md5(appId+securityId)

响应实例:

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "identityCategoryCode": "01", // 身份类型code
      "operatorIpPool": "aaa" // IP池名称
    }
  ]
}
// 查询不存在
{
  "code": 204, // 204
  "message": "No Content",
  "data": null
}
// 业务异常
{
  "code": "412", // 412参数错误
  "message": "Precondition Failed",
  "data": {
    "errorCode": "xxx", // 更多错误码见附件
    "errorMessage": "xxxx"
  }
}

1.7.2 获取不允许接入的IP段

请求地址:

请求地址: https://self.xxxx.xxx.xx/data-sync/public/network/5g/config/getExternalIpSegment/{appId}

请求地址: https://sso.xxxx.xxx.xx/{定义路径按需}/gate/data-sync/public/network/5g/config/getExternalIpSegment/{appId}

请求方式: POST

请求类型: application/json;charset=utf-8

功能说明:

获取不允许接入的IP段，2种分配方式：下发运营商IP池、IP段内分配固定IP, ，请求地址由项目工程师提供

请求头:

请求参数:

无

返回参数:

请求实例: 请求头：

Authorization : Bearer md5(appId+securityId)

响应实例:

// 下发运营商IP池
{
  "code": 200,
  "message": "OK",
  "data": {
    "ipAllocateWay": "OPERATOR_DHCP",
    "operatorIpPool": "bbb",
    "ipSegments": null
  }
}

// IP段内分配固定IP
{
  "code": 200,
  "message": "OK",
  "data": {
    "ipAllocateWay": "LOCAL_STATIC",
    "operatorIpPool": null,
    "ipSegments": [
      {
        "id": "646c82ee5f40f600018fc1e3",
        "start": "10.10.11.1",
        "end": "10.10.11.254",
        "startDecimal": 168430337,
        "endDecimal": 168430590
      },
      {
        "id": "646c82ee5f40f600018fc1e4",
        "start": "10.10.12.1",
        "end": "10.10.12.254",
        "startDecimal": 168430593,
        "endDecimal": 168430846
      }
    ]
  }
}

1.8 错误代码说明