sync: 同步文档 v1.0.4 并脱敏

This commit is contained in:
MiFaZhan
2026-10-29 15:45:46 +08:00
parent c49b2bf404
commit 3ab3682d14
138 changed files with 514 additions and 477 deletions
+19 -11
View File
@@ -9,15 +9,23 @@ outline: deep
## 服务地址
```text
https://apiv3.5iot.cn
https://api.example.com
```
HTTP(`http://apiv3.5iot.cn`)仅为存量兼容保留,不做自动跳转,新接入请使用 HTTPS。
HTTP(`http://api.example.com`)仅为存量兼容保留,不做自动跳转,新接入请使用 HTTPS。
## 鉴权
先调用 `/openapi/v3/query/token` 获取访问令牌,再在请求头中传入 `X-Access-Token`。请求体中的 `appId` 必须与凭证所属客户一致。
## 标准入口与兼容入口
新接入统一使用本文的 `/openapi/v3/change/*` 路径。原 `/openapi/v3/common/*` 前缀已停止提供,调用返回 `404`,请改用 `/change` 下的对应接口。
批量续费使用 `/change/batch-sim-subscribe`;历史 `/change/renew` 接收 `cards[]`,允许每张卡携带套餐信息,作为兼容入口保留。两者共用续费实现。
批量变更达量断网使用 `/change/batch-sim-traffic-cutoff`。原 `/change/traffic-cutoff-config` 不再对外提供,请改用标准入口——两者请求参数完全一致,迁移无需改动报文体。`/query/traffic-cutoff-config` 仅查询配置。
## 统一返回结构
```json
@@ -63,7 +71,7 @@ POST /openapi/v3/change/sim-subscribe
```json
{
"appId": "CUS-202608-0001",
"iccid": "89860401785462635152",
"iccid": "89860400000000005152",
"packageId": "001",
"validity": 1,
"remark": "客户单卡续费"
@@ -95,7 +103,7 @@ POST /openapi/v3/change/sim-subscribe
"data": {
"orderId": "54",
"orderSn": "REN20260910153546001000001",
"iccid": "89860401785462635152",
"iccid": "89860400000000005152",
"planName": "中移-1G",
"effectiveType": "immediate",
"effectiveDate": "2026-09-10 15:35:46",
@@ -116,7 +124,7 @@ POST /openapi/v3/change/sim-subscribe
"data": {
"orderId": "0",
"orderSn": "",
"iccid": "89860401785462635152",
"iccid": "89860400000000005152",
"planName": "",
"effectiveType": "",
"effectiveDate": "",
@@ -157,7 +165,7 @@ POST /openapi/v3/change/sim-traffic-cutoff
```json
{
"appId": "CUS-202608-0001",
"iccid": "89860401785462635152",
"iccid": "89860400000000005152",
"trafficCutoffStatus": 1,
"trafficCutoffThreshold": 1024,
"remark": "客户开启达量断网"
@@ -186,8 +194,8 @@ POST /openapi/v3/change/sim-traffic-cutoff
"message": "",
"data": {
"success": true,
"iccid": "89860401785462635152",
"msisdn": "14162635152",
"iccid": "89860400000000005152",
"msisdn": "14100005152",
"imsi": "460045462635152",
"trafficCutoffStatus": 1,
"trafficCutoffThreshold": 1024,
@@ -206,7 +214,7 @@ POST /openapi/v3/change/sim-traffic-cutoff
"message": "",
"data": {
"success": false,
"iccid": "89860401785462635152",
"iccid": "89860400000000005152",
"trafficCutoffStatus": 1,
"trafficCutoffThreshold": 1024,
"trafficCutoffThresholdUnit": "MB",
@@ -249,7 +257,7 @@ POST /openapi/v3/change/batch-sim-subscribe
"appId": "CUS-202608-0001",
"cards": [
{
"iccid": "89860401785462635152"
"iccid": "89860400000000005152"
}
],
"packageId": "001",
@@ -313,7 +321,7 @@ POST /openapi/v3/change/batch-sim-traffic-cutoff
"appId": "CUS-202608-0001",
"cards": [
{
"iccid": "89860401785462635152"
"iccid": "89860400000000005152"
}
],
"trafficCutoffStatus": 1,