API文档

版本:v0.2 创建时间: 2020/8/3

通用说明

1.接口返回说明

所有接口均会返回 code 和 msg 两个参数:
正常返回:

{
"code": 1,
"msg": "查询成功",
"time": 1583560304,
"data":{},
}

错误返回:

{
"code": 0,
"msg": "查询失败",
"time": 1583560304,
"data":{},
}

code中 1 为成功, 0 为失败

2.签名

参数以键值对形式链接后进行md5加密并大写，涉及参数包含id, secret, times,顺序如下:

所有接口参数均需要带以下参数，下同，故不再说明:

3.接口

base_url 为用户域名

二 接口列表

1.查询卡板流量

请求方式: GET/POST
查询地址: api/agent/flow
请求参数:

请注意每秒查询次数不能超过1次。
返回示例:

{
 "code": 1,
 "msg": "查询成功",
 "time": 1583560304,
 "data":
  {
  "cardno": "8742999",
  "iccid": "8742999",
  "flow": 1024,
  "addcardno" :"8742999",  //新增移动附加卡号
  "remainflow": -1,
  "usedflow": 0,
  "delete_on": null,
  "status":1,
 }
}

flow 为总流量, remainflow 为剩余流量, usedflow 为使用流量， delete_on 为到期时间
状态:0=异常,1=待激活,2=已激活,3=已断网,4=停机,5=违章停机,6=销户,7=库存,8=其他

2. 查询卡板套餐

请求方式: GET/POST
查询地址: api/agent/package
请求参数:

返回示例:

{
"code": 1,
"msg": "查询成功",
"time": 1583561679,
"data":[
        {
            "packagelist_id": 4,
      "name": "移动量卡300G",
      "price": "88.50", 
    },
 ]
}

packagelist_id 套餐id , price 价格

3. 订购套餐

请求方式: GET/POST
查询地址: api/agent/order
请求参数:

返回示例:

{
    "code": 1,
    "msg": "订购成功",
    "data": {
        "orderno": "201511181328427155909265"
    }
}

4.查询余额

请求方式: POST
查询地址: api/agent/user
请求参数: 无
返回示例:
请注意每10秒查询次数不能超过1次。

{
"code": 1,
"msg": "操作成功",
"time": 1583561679,
"data":[
    {
        "rebate":0.0
    },
    ]
}

5.查询卡状态(部分可用)

请求方式: GET/POST
查询地址: api/agent/info
请求参数:
请注意每5秒查询次数不能超过3次。

返回示例:

{
    "code": 1,
    "msg": "查询成功",
    "time": 1583561459,
    "data":{
        "cardno": "8742999",
        "certification": "1",
        "isactive": "0",
    }
}

certification 为是否实名 isactive 为卡是否激活

6.查询是否实名

请求方式: GET/POST
查询地址: api/agent/getcertinfo
请求参数:

返回示例:

{"code":1,
 "msg":"查询成功",
 "time":"1620962192",
 "data":{"code":2,"url":""}
}

code 1为需要实名，2为已实名 （是指的data里面的code的值，非最外层，如示例里面code为2）

以下功能2021-6-1版本以后新增，请联系上级确认是否为2021-6-1之后版本

7.卡板复机

请求方式: GET/POST
查询地址: api/agent/start
请求参数:

返回示例:

{"code":1,
 "msg":"成功",
 "time":"1620962192",
 "data":""
}

若为失败， code 为0

8.卡板停机

请求方式: GET/POST
查询地址: api/agent/stop
请求参数:

返回示例:

{"code":1,
 "msg":"成功",
 "time":"1620962192",
 "data":""
}

若为失败， code 为0

7.卡板刷新

请求方式: GET/POST
查询地址: api/agent/refresh
请求参数:

返回示例:

{"code":1,
 "msg":"成功",
 "time":"1620962192",
 "data":""
}

若为失败， code 为0