鸿升OBOS操作手册
档案信息接口

服务地址：http://obos.hopechart.com/api/v1.0

头部信息：发起 API 调用时需在 Http 请求头填写如下参数

  • Content-Type application/x-www-form-urlencoded; charset=UTF-8
  • systemCode 系统编码 - 联系管理员申请
  • x-auth-token 授权码 - 联系管理员申请

示例代码如下：

headers.put("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
headers.put("systemCode", "系统编码");
headers.put("x-auth-token", "授权码");
1
2
3

# 1.新增客户

# 1.1. 接口功能

通过远程接口调用，实现在 OBOS 平台新增客户信息。

# 1.2. URL

/archive/customer

# 1.3. 请求方式

POST

# 1.4. 请求参数

参数名称 参数类型 是否必选 参数说明
realname String Y 客户名称
contact String N 联系人
area String N 区域
address String N 联系地址
email String N 邮箱
mobile Integer N 联系人移动电话
officePhone String N 办公电话
remark String N 备注

# 1.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非 200）
message String 消息

# 1.6. 请求示例

http://obosapi.hopechart.com/api/v1.0/archive/customer

{
    "realname": "北奔重型汽车集团有限公司",
    "contact": "振宇杨",
    "area": "包头市",
    "address": "包头市青山区装备制造产业园区一机厂正门东50米处路南",
    "email": "beiben@qq.com",
    "mobile": "18888888888",
    "officePhone": "(0472)3119191",
    "remark": "接口调用"
}
1
2
3
4
5
6
7
8
9
10

# 2.新增 SIM 卡

# 2.1. 接口功能

通过远程接口调用，实现在 OBOS 平台新增 SIM 卡信息。

# 2.2. URL

/archive/sim

# 2.3. 请求方式

POST

# 2.4. 请求参数

参数名称 参数类型 是否必选 参数说明
simNo String Y SIM 卡号
iccid String N SIM 卡 ICCID 号
carrier String N 运营商名称
cardState String N 卡状态编号（1：测试待激活 2：测试激活 3：测试关停 4：测试结束 5：待激活 6：已激活 7：停卡 8：小卡 9：断网）
activeTime String N 激活时间（2021-06-06 12:00:00）
productPackage String N 产品套餐
serviceStartTime String N 服务开始日期（2021-06-06 12:00:00）
serviceEndTime String N 服务结束日期（2021-06-06 12:00:00）
packageCapacity Integer N 套餐容量
usedCapacity Integer N 已使用量
remainingCapacity Integer N 套餐剩余
source Integer Y 数据来源(填 1)
remark String N 备注

# 2.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非 200）
message String 消息

# 2.6. 请求示例

http://obosapi.hopechart.com/api/v1.0/archive/sim

{
    "simNo": "13888881341",
    "iccid": "32888881341138888813",
    "carrier": "yd",
    "cardState": "6",
    "activeTime": "2020-12-01 12:30:00",
    "productPackage": "",
    "serviceStartTime": "2020-12-01 12:30:00",
    "serviceEndTime": "2022-12-01 12:30:00",
    "packageCapacity": "10G",
    "usedCapacity": "3G",
    "remainingCapacity": "7G",
    "source": "1",
    "remark": "SIM同步"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 3.新增终端档案

# 3.1. 接口功能

通过远程接口调用，实现在 OBOS 平台新增终端档案信息。

# 3.2. URL

/archive/terminal

# 3.3. 请求方式

POST

# 3.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminal String Y 10 位终端号
terminal7 String N 7 位终端号
terminalEx String N 扩展终端号
simOne String Y SIM 卡 1
simIccidOne String N SIM 卡 1 ICCID）
simTwo String N SIM 卡 2
simIccidTwo String N SIM 卡 2 ICCID
barcode String N 条码
productName String Y 产品名称 - 终端小型号
productionTime String N 生产日期（2021-06-06 12:00:00）
deliveryTime String N 发货日期（2021-06-06 12:00:00）
org Integer Y 所属组织（填值 1）
source Integer Y 1：同步
remark String N 备注

# 3.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非 200）
message String 消息

# 3.6. 请求示例

http://obosapi.hopechart.com/api/v1.0/archive/terminal

{
    "terminal": "3572875388",
    "terminal7": "25Q8258",
    "terminalEx": "",
    "simOne": "13888888888",
    "simIccidOne": "13888888888138888888",
    "simTwo": "",
    "simIccidTwo": "",
    "barcode": "HQ202104201000001",
    "productName": "HQA-801",
    "productionTime": "2021-04-20 10:00:00",
    "deliveryTime": "2021-05-08 12:00:00",
    "vendor": "陕重汽",
    "org": 1,
    "source": "1",
    "remark": "终端同步"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 4.新增产品型号

# 4.1. 接口功能

通过远程接口调用，实现在 OBOS 平台新增产品型号信息。

# 4.2. URL

/archive/productModel

# 4.3. 请求方式

POST

# 4.4. 请求参数

参数名称 参数类型 是否必选 参数说明
modelName String Y 型号名称
productType String Y 产品类型编码(A：行驶记录仪【斑马】 G：车载中控屏【孔雀】T：TBOX【灵狐】V：视频录像机【星鸦】)
productSeries String Y 产品系列编码：(2：2G 部标机系列 3：4G 部标机系列 4：5G 部标机系列)
productFlag String N 产品标识
releaseTime String N 发布时间（2021-06-06 12:00:00）
upgradeModel String Y 升级模式（ABOS、GBOS、FTP、HTTP 多个以英文逗号分隔）
remark String N 备注

# 4.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非 200）
message String 消息

# 4.6. 请求示例

http://obosapi.hopechart.com/api/v1.0/archive/productModel

{
    "modelName": "HQA-801",
    "productType": "A",
    "productSeries": "3",
    "productFlag": "",
    "releaseTime": "2021-06-06 12:00:00",
    "upgradeModel": "FTP,HTTP",
    "remark": "同步产品型号"
}
1
2
3
4
5
6
7
8
9

# 5.福田/华菱终端号

# 5.1. 接口功能

通过远程接口调用，实现在 OBOS 平台新增福田/华菱 10 位、7 位终端号关系信息。支持批量添加。

# 5.2. URL

/archive/terminalCustomer/batch

# 5.3. 请求方式

POST

# 5.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminal String Y 10 位终端号
terminal7 String Y 7 位终端号
terminalEx String N 扩展终端号
barcode String Y 终端条码
customerCode String N 客户代码
customerName String Y 客户名称
traceCode String Y 追溯码
remark String N 备注

# 5.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非 200）
message String 消息

# 5.6. 请求示例

http://obosapi.hopechart.com/api/v1.0/archive/terminalCustomer/batch

[
    {
        "terminal": "2105260492",
        "terminal7": "5260492",
        "terminalEx": "",
        "barcode": "1133112105260492",
        "customerCode": "sq",
        "customerName": "陕重汽",
        "traceCode": "FFSDDD1133112105260492",
        "remark": "华菱/福田终端关系同步"
    },
    {
        "terminal": "1205360212",
        "terminal7": "5360212",
        "terminalEx": "",
        "barcode": "536021205260492",
        "customerCode": "sq",
        "customerName": "陕重汽",
        "traceCode": "DDS321133112105260492",
        "remark": "华菱/福田终端关系同步"
    }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Last Updated: 7/30/2021, 3:51:49 PM