全局公共参数

全局Header参数

全局Query参数

全局Body参数

全局认证方式

无需认证

状态码说明

卡仓云接口2.0

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2023-11-21 21:42:45

更新时间: 2024-04-01 17:42:58

卡仓云系统2.0API接口

目录Header参数

目录Query参数

目录Body参数

目录认证信息

继承父级

接口约定

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2024-09-11 17:34:17

更新时间: 2024-09-11 18:27:34

接口约定

由于系统全面对接口升级优化，部分接口已经修改。请按照文档内修改

请求公共参数

签名规则

签名的生成逻辑如下： 按键名排序：对请求参数进行按键名排序。 生成签名字符串：将排序后的键值对按 key=value 形式拼接，键值对之间使用 & 连接。 追加密钥：在拼接后的字符串末尾追加密钥。 生成MD5签名：对最终字符串进行MD5哈希，生成签名。,如果参数为空不参与签名,php实例 `function generateSignature($params, $secretKey) { ksort($params); $paramString = ''; foreach ($params as $key => $value) { if ($value !== '') { $paramString .= $key . '=' . $value . '&'; } }

$paramString .= $secretKey;
return md5($paramString);

}`,其他语言可参考函数规则

IP白名单与回调地址

暂时未启用该能力

订单状态码

订单状态由于方便接入方处理已对状态转义，以中文字符串展现,未处理,已下单,已发货,已完成,开卡失败,待传身份证

号卡状态

已激活,未激活

首充状态

已首充,未首充

提单接口

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2023-11-21 21:44:38

更新时间: 2024-09-11 18:27:42

xxxxxxxxxx
暂无描述

接口状态

已完成

接口URL

域名+/api/V1/ApiOpenToOrder

请求方式

POST

Content-Type

form-data

请求Body参数

认证方式

继承父级

响应示例

• 成功(200)

xxxxxxxxxx
{
    "code": 33,
    "msg": "下单成功",
    "cardStatus": 0,
    "orderid": "JYHK0212651566844545"
}

• 失败(503)

xxxxxxxxxx
{
    "code": "406",
    "msg": "签名不正确"
}

• 失败(400)

xxxxxxxxxx
{
    "code": -2,
    "msg": "身份证号码有误，请重新输入"
}

订单查询接口

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2023-11-21 23:18:33

更新时间: 2024-09-11 18:50:02

DownOrderID为对接方的订单号！,重复订单请勿重复查询！请对接方自行过滤，已经失败或者未提交的订单请不要重复查询

接口状态

已完成

接口URL

域名/api/V1/ApiOpenGetOrder

请求方式

POST

Content-Type

form-data

请求Body参数

认证方式

继承父级

响应示例

• 成功(200)

xxxxxxxxxx
{
    "code": 2,
    "msg": "成功",
    "data": {
        "OrderId": "JYHK20240911796654",
        "DownOrderID": "KSSD64511551",
        "Name": "李易",
        "Notes": "已经提交运营商审核",
        "CreateTime": "2024-09-11 17:26:47",
        "CardStatus": "未激活",
        "ThirdPhone": "16685523947",
        "FirstCharge": "未首充",
        "ChargeAmount": null,
        "ChargeTime": "1970-01-01 08:00:00",
        "OnlineStatus": "未在网",
        "Exorder": "KSSD64511551",
        "OrderStatus": "已下单",
        "Express": "",
        "Exnumber": ""
    }
}

• 失败(200)

xxxxxxxxxx
{
    "code": -200,
    "msg": "订单不存在"
}

产品上下架状态

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2023-11-21 23:32:01

更新时间: 2024-09-11 18:58:46

ProductID为产品ID，可传单独ID或者为空，为空代表查询所有商品！无论传什么接口只会返回属于当前PUID的数据

接口状态

已完成

接口URL

域名+/api/V1/ApiOpenGetShop

请求方式

POST

Content-Type

form-data

请求Body参数

认证方式

继承父级

响应示例

• 成功(200)

xxxxxxxxxx
{
    "code": 2,
    "msg": "成功",
    "data": [
        {
            "ProductID": "99",
            "ProductName": "联通龙腾卡",
            "ProductStatus": "上架中"
        }
    ]
}

• 失败(500)

xxxxxxxxxx
{
    "code": 400,
    "msg": "产品ID9999不存在"
}

产品选号接口

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2024-04-01 15:28:15

更新时间: 2024-09-13 12:27:08

本接口用于运营商选号 需对应相应产品 请按照设计规范开发！返回checkCode和Region时提单必传 签名方式按照自然排序追加秘钥 ！

接口状态

已完成

接口URL

域名+/api/V1/ApiOpenSeNum

请求方式

POST

Content-Type

form-data

请求Body参数

认证方式

继承父级

响应示例

• 成功(200)

xxxxxxxxxx
{
    "code": 2,
    "data": [
        {
            "Number": "17585476648",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585706615",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585706628",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585715661",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585476698",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17508516671",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585706690",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585473669",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585476618",
            "Region": "",
            "checkCode": ""
        },
        {
            "Number": "17585477669",
            "Region": "",
            "checkCode": ""
        }
    ],
    "msg": "成功"
}

• 失败(201)

xxxxxxxxxx
{
    "code": 201,
    "msg": null
}

• 返回特殊数据号码(200)

xxxxxxxxxx
{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "Number": "15780585419",
            "Region": "A",
            "checkCode": "fGQvFND/DCIDNDPzs9TFUGBFxcW71t2BWaUBeSXRxUskYemZafowSBPqp6x8wZt7TSypduRz/6CD+K+l6Welqw=="
        },
    ]
}

上传三证接口

创建人: 厄俄斯

更新人: 厄俄斯

创建时间: 2024-09-11 19:46:11

更新时间: 2024-09-11 20:21:47

图片数据必须为Base64位数据。 三证图片和参数不参与签名算法

接口状态

已完成

接口URL

域名+/api/V1/ApiOpenReName

请求方式

POST

Content-Type

form-data

请求Body参数

认证方式

继承父级

响应示例

• 成功(200)

xxxxxxxxxx
{
    "code": 200,
    "msg": "上传成功"
}

• 失败(404)

xxxxxxxxxx
{
    "code": -1,
    "msg": "已上传三证，请勿重复操作"
}