iotlcm-public/iotlcm
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/openapi/v3/common.md
+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,
docs/openapi/v3/index.md
+5 -3
View File
@@ -9,10 +9,10 @@ outline: deep
## 服务地址
```text
https://apiv3.5iot.cn
https://api.example.com
```
HTTP（`http://apiv3.5iot.cn`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
HTTP（`http://api.example.com`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
## 统一返回结构
@@ -76,4 +76,6 @@ X-Access-Token: {accessToken}
⚠️ **不要把 `appKey`（API 账号标识）当成 `appId` 使用。** `appKey` 只用于获取 token。
:::
权限控制：调用接口需具备对应接口资源的访问权限，权限与 API 账号所属权限组关联。未配置资源时，按当前开放策略放行。
权限控制：调用接口需具备对应接口资源的访问权限，权限与 API 账号所属权限组关联。未登记资源、资源停用、账号未授权均拒绝访问，返回 `10014`；权限数据查询异常返回 `10016`（系统侧故障，不是授权问题）。
原 `/openapi/v3/common/*` 前缀已停止提供，调用返回 `404`，请使用 `/openapi/v3/change/*` 下的对应接口。
docs/openapi/v3/query.md
+30 -30
View File
@@ -32,7 +32,7 @@ X-Access-Token: {accessToken}
```json
{
"appId": "CUS-202601-0001",
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
}
```
@@ -90,9 +90,9 @@ X-Access-Token: {accessToken}
"code": 0,
"message": "",
"data": {
"iccid": "898604F4152391115474",
"iccid": "89860400000000005474",
"imei": "",
"username": "山东云则",
"username": "示例企业",
"location": "370100000000",
"planCategory": "移动小流量",
"currentPlanName": "每月100m3年",
@@ -162,7 +162,7 @@ X-Access-Token: {accessToken}
```json
{
"appId": "CUS-202601-0001",
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
}
```
@@ -184,7 +184,7 @@ X-Access-Token: {accessToken}
"code": 0,
"message": "",
"data": {
"iccid": "898604F4152391115474",
"iccid": "89860400000000005474",
"lifeCycle": 2,
"lifeCycleName": "已激活"
},
@@ -225,7 +225,7 @@ POST /openapi/v3/query/sim-limit
```json
{
"appId": "CUS-202601-0001",
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
}
```
@@ -272,7 +272,7 @@ POST /openapi/v3/query/sim-imei
```json
{
"appId": "CUS-202601-0001",
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
}
```
@@ -315,7 +315,7 @@ POST /openapi/v3/query/sim-usage
```json
{
"appId": "CUS-202601-0001",
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
}
```
@@ -371,13 +371,13 @@ X-Access-Token: {accessToken}
"appId": "CUS-202601-0001",
"cards": [
{
"iccid": "898604F4152391115473"
"iccid": "89860400000000005473"
},
{
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
},
{
"iccid": "8986112223600594371"
"iccid": "8986110000000004371"
}
]
}
@@ -414,19 +414,19 @@ X-Access-Token: {accessToken}
"items": [
{
"matched": true,
"iccid": "898604F4152391115473",
"iccid": "89860400000000005473",
"lifeCycle": 2,
"lifeCycleName": "已激活"
},
{
"matched": true,
"iccid": "898604F4152391115474",
"iccid": "89860400000000005474",
"lifeCycle": 2,
"lifeCycleName": "已激活"
},
{
"matched": true,
"iccid": "8986112223600594371",
"iccid": "8986110000000004371",
"lifeCycle": 2,
"lifeCycleName": "已激活"
}
@@ -467,13 +467,13 @@ X-Access-Token: {accessToken}
"appId": "CUS-202601-0001",
"cards": [
{
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
},
{
"iccid": "898604F4152391115473"
"iccid": "89860400000000005473"
},
{
"iccid": "8986112223600594371"
"iccid": "8986110000000004371"
}
]
}
@@ -510,19 +510,19 @@ X-Access-Token: {accessToken}
"items": [
{
"matched": true,
"iccid": "898604F4152391115474",
"iccid": "89860400000000005474",
"useUnit": "MB",
"useAmount": 0.875
},
{
"matched": true,
"iccid": "898604F4152391115473",
"iccid": "89860400000000005473",
"useUnit": "MB",
"useAmount": 12.5
},
{
"matched": true,
"iccid": "8986112223600594371",
"iccid": "8986110000000004371",
"useUnit": "MB",
"useAmount": 36.25
}
@@ -563,10 +563,10 @@ X-Access-Token: {accessToken}
"appId": "CUS-202601-0001",
"cards": [
{
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
},
{
"iccid": "898604F4152391115473"
"iccid": "89860400000000005473"
},
{
"msisdn": "1441543605474"
@@ -605,12 +605,12 @@ X-Access-Token: {accessToken}
"items": [
{
"matched": true,
"iccid": "898604F4152391115474",
"iccid": "89860400000000005474",
"imei": ""
},
{
"matched": true,
"iccid": "898604F4152391115473",
"iccid": "89860400000000005473",
"imei": "865466070817587"
},
{
@@ -651,13 +651,13 @@ POST /openapi/v3/query/traffic-cutoff-config
"appId": "CUS-202601-0001",
"cards": [
{
"iccid": "898604F4152391115474"
"iccid": "89860400000000005474"
},
{
"iccid": "898604F4152391115475"
"iccid": "89860400000000005475"
},
{
"iccid": "898604F4152391115476"
"iccid": "89860400000000005476"
}
],
"includeUsage": true
@@ -699,7 +699,7 @@ POST /openapi/v3/query/traffic-cutoff-config
"items": [
{
"matched": true,
"iccid": "898604F4152391115474",
"iccid": "89860400000000005474",
"trafficCutoffStatus": 0,
"trafficCutoffStatusName": "未配置",
"trafficCutoffThreshold": 0,
@@ -710,7 +710,7 @@ POST /openapi/v3/query/traffic-cutoff-config
},
{
"matched": true,
"iccid": "898604F4152391115475",
"iccid": "89860400000000005475",
"trafficCutoffStatus": 1,
"trafficCutoffStatusName": "已开启",
"trafficCutoffThreshold": 100,
@@ -721,7 +721,7 @@ POST /openapi/v3/query/traffic-cutoff-config
},
{
"matched": true,
"iccid": "898604F4152391115476",
"iccid": "89860400000000005476",
"trafficCutoffStatus": 2,
"trafficCutoffStatusName": "已关闭",
"trafficCutoffThreshold": 50,
docs/openapi/v3/token.md
+3 -3
View File
@@ -24,8 +24,8 @@ POST /openapi/v3/query/token
```json
{
"appKey": "b96b84a4d70740c1bfe569a11ca62e219affe3a6",
"appSecret": "588035550bd35c0001fbcda2c4d812ebdebae9763127943f097758e029a0fdbc"
"appKey": "example-app-key",
"appSecret": "example-app-secret"
}
```
@@ -50,7 +50,7 @@ POST /openapi/v3/query/token
"message": "",
"data": {
"appId": "CUS-202601-0001",
"accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJ1IjoiZWE3ZjJiZGY5MjQyNDFkZjg3NGIwZDMzNmZkN2UzMzEiLCJleHAiOjE3ODQ3MDAyODB9.JiYK-CXdXQKKU0UNhNOqKX5Hzyk4lVMtIpunQJDxlBI"
"accessToken": "example-access-token"
},
"error": null
}