Linksfield Developer
OverviewCube APIs旧版本API
OverviewCube APIs旧版本API
  1. Notification
  • CSSS APIs
    • 全局说明/Overview
    • 国际化/ Internationalization
    • 状态码/Status code
    • 签名代码示例 / Sign code Example
    • SIM
      • 批量获取拥有的设备信息/Get all SIM cards info
      • 查询单一设备实时信息/Get real-time info about one SIM card
      • 同步使用中SIM卡信息/Get the SIM Cards in use
    • Usage
      • 查询单张SIM卡流量使用情况/ Example Query the traffic usage of a single SIM card
      • 批量查询SIM卡流量接口 /Batch querying SIM card usage
      • 查询单日流量使用情况 / Example Query the daily usage
      • 批量查询指定月份的流量使用情况/ Batch querying the usage in a specified month
    • Plan
      • 同步资费套餐 / Get data plan
      • 订购流量套餐/ Order data plan
      • 批量订购套餐/ Bulk order package
      • 续订流量套餐/ Renew your data plan
      • 查询套餐订单信息 / Query the package order information
      • 开通/启用流量套餐订单 / To enable the order
      • 取消流量套餐订单/ Cancel an unenabled package order
      • 提前结束设备套餐订单/ End package orders early
      • [不推荐]停机/暂停流量套餐订单
      • [不推荐]复机/重新启动流量套餐订单
      • 【不推荐】分页批量(查询)同步设备可订购套餐
    • SMS
      • 发送短信/ send SMS
    • Customized
      • OTA日套餐下单/Order OTA Plan
      • 运营商侧剩余流量查询/Query the remaing data by MNO side
  • Notification
    • Notification全局说明
    • Notification状态码
    • 流量使用量API预警
      POST
    • 短信下行回调
      POST
    • 短信上行回调
      POST
    • 短信上行回调(区分文本二进制)
      POST
    • 订单状态变更回调(IMSI)
      POST
  • Mall APIs
    • Mall全局说明
    • Mall业务流程
    • Mall签名代码示例
    • APP调用Stripe的SDK示例说明
    • Vshop
      • 卡片登录验证
      • 获取可购套餐商品列表
      • 创建用户订单
      • 查询正在使用、未启用订单
      • 获取生效中的自动续费
      • 关闭自动续费
      • 用户下单(第三方支付)
    • Payment
      • 获取stripe单次支付权限
      • 获取Stripe订阅支付权限
      • 创建Stripe订阅/自动续费
      • 支付结果查询
    • Notification
      • 消息推送
        POST
  • eSIM QR Mall APIs
    • Introduction
    • Pre - order
      POST
    • webhook
      POST
    • 用户登录
      POST
    • My eSIM Detail
      POST
  1. Notification

消息推送

开发中
Cube UAT
https://api-uat.io.linksfield.net/cube/v4
Cube UAT
https://api-uat.io.linksfield.net/cube/v4
POST
客户自定义的URL

签名#

为了接收方能对API消息来源进行验证,推送消息的header中加入了x-lf-md5参数,注意算法如下:
在header增加MD5参数
x-lf-md5 : base64(MD5("key1=value1&key2=value2&secret))
(key, value)为body中的参数,计算时按字典序排列
类型1:{}对象按自然排序key1=value1&key2=value2&secret,
类型2: [] 中每个对象中成员按自然排序,对象间按list顺序拼接 key1=value1&key2=value2&key1=value11&key2=value22&secret
(secret与调用领科API时的密钥不一致,请单独联系领科人员获取)

推送消息类型#

当前系统定义了如下事件类型并提供API推送
warningCode业务描述推送频率
1未购买套餐:首单已启用但无其他订单的设备信息,进行推送。数据推送为量全推送,即一台设备数据可能推送多次。同一次推送中,同一张卡不会重复出现。但若卡片一直未购买,则可能会每周推送一次。固定周期,北京时间每周二上午9点
2套餐到期不足7天:查询时间与订单到期时间差值为小于7天的设备信息。同一张卡快到期又购买了新套餐不会推送固定周期,北京时间每周二上午9点
3套餐已过期:设备无未启用订单,且使用中的订单(非首单)状态变更为已结束。结束时间距离当前时间超过7天的也会包含在推送范围内。固定周期,北京时间每周二上午9点
-1购买套餐成功实时触发,用户套餐订购成功

请求参数

Header 参数
x-lf-md5
string 
可选
base64(MD5("key1=value1&key2=value2&secret))
x-lf-delivery
string 
可选
unique id (snowflake)
Body 参数application/json
devices
array [object {3}] 
必需
expireTime
string 
套餐订单过期时间
可选
warningCode
string 
必需
编码 1无购买套餐 2即将到期 3已到期 4体验套餐流量耗尽(仅部分资源支撑)-1已购买
deviceId
string 
SIM卡ICCID
必需
示例
{
    "devices": [
        {
            "expireTime": "",
            "warningCode": "1",
            "deviceId": "89314404000816575667"
        },
         {
            "expireTime": "",
            "warningCode": "1",
            "deviceId": "89314404000816575667"
        },
         {
            "expireTime": "",
            "warningCode": "1",
            "deviceId": "89314404000816575667"
        }
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-uat.io.linksfield.net/cube/v4客户自定义的URL' \
--header 'x-lf-md5;' \
--header 'x-lf-delivery;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "devices": [
        {
            "expireTime": "",
            "warningCode": "1",
            "deviceId": "89314404000816575667"
        },
         {
            "expireTime": "",
            "warningCode": "1",
            "deviceId": "89314404000816575667"
        },
         {
            "expireTime": "",
            "warningCode": "1",
            "deviceId": "89314404000816575667"
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
code
string 
必需
0-成功,非0-失败
message
string 
必需
示例
{
    "code": "string",
    "message": "string"
}
修改于 2023-05-16 03:33:24
上一页
支付结果查询
下一页
Introduction
Built with