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

docs: update API endpoint examples safely

Browse Source 
Use the documented API host and replace credential fragments with placeholders.
This commit is contained in:
Dai0814
2026-10-26 16:12:43 +08:00
parent 19455e1cbc
commit 37a1d00f01
7 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/openapi/legacy/index.md
+4 -4
View File
@@ -8,18 +8,18 @@ outline: deep
本文档收录历史 `/route/open/*` 路径下仍在维护的兼容接口。鉴权通过请求体 `verify` 中的 `appId`、`password` 和 `timeStamp` 完成；`sign` 为历史兼容字段，当前服务不校验。
这些接口由 iotLCM OpenAPI 服务实现并提供，与 V3 接口同域（`api.iotlcm.example.com`），仅请求路径与鉴权方式不同。
这些接口由 iotLCM OpenAPI 服务实现并提供，与 V3 接口同域（`apiv3.5iot.cn`），仅请求路径与鉴权方式不同。
## 服务地址
```text
https://api.iotlcm.example.com
https://apiv3.5iot.cn
```
完整请求 URL：
```text
https://api.iotlcm.example.com/route/open/{接口名}
https://apiv3.5iot.cn/route/open/{接口名}
```
## 统一鉴权
@@ -82,7 +82,7 @@ appId={appId}&password={password}&timeStamp={timeStamp}&key={accessKey}
```java
// 服务器请求地址
protected static String server_Ip = "https://api.iotlcm.example.com/route/open";
protected static String server_Ip = "https://apiv3.5iot.cn/route/open";
// appId
public static String appId = null;
// 密钥密码
docs/openapi/legacy/query.md
+6 -6
View File
@@ -31,7 +31,7 @@ POST /route/open/cardInfo
},
"verify": {
"timeStamp": "1784097284347",
"password": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc",
"password": "YOUR_APP_SECRET",
"appId": "YOUR_APP_ID",
"sign": ""
}
@@ -111,7 +111,7 @@ POST /route/open/simDataUsage
},
"verify": {
"timeStamp": "1784097284347",
"password": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc",
"password": "YOUR_APP_SECRET",
"appId": "YOUR_APP_ID",
"sign": ""
}
@@ -161,7 +161,7 @@ POST /route/open/simDataUsageMonthly
},
"verify": {
"timeStamp": "1784097284347",
"password": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc",
"password": "YOUR_APP_SECRET",
"appId": "YOUR_APP_ID",
"sign": ""
}
@@ -209,7 +209,7 @@ POST /route/open/simStatus
},
"verify": {
"timeStamp": "1784097284347",
"password": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc",
"password": "YOUR_APP_SECRET",
"appId": "YOUR_APP_ID",
"sign": ""
}
@@ -257,7 +257,7 @@ POST /route/open/simSession
},
"verify": {
"timeStamp": "1784097284347",
"password": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc",
"password": "YOUR_APP_SECRET",
"appId": "YOUR_APP_ID",
"sign": ""
}
@@ -334,7 +334,7 @@ POST /route/open/queryCardInfoList
},
"verify": {
"timeStamp": "1784097284347",
"password": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc",
"password": "YOUR_APP_SECRET",
"appId": "YOUR_APP_ID",
"sign": ""
}
docs/openapi/operator/mobile-v5/index.md
+7 -7
View File
@@ -1,31 +1,31 @@
---
title: 白名单转发
description: 通过 api.iotlcm.example.com 访问中国移动物联网能力开放平台 V5 接口
description: 通过 apiv3.5iot.cn 访问中国移动物联网能力开放平台 V5 接口
outline: deep
---
# 白名单转发
本目录说明如何通过 `api.iotlcm.example.com` 访问中国移动物联网能力开放平台 V5 接口。平台仅提供安全代理转发，不改变中国移动 V5 接口的请求方法、请求参数、响应结构和业务语义。
本目录说明如何通过 `apiv3.5iot.cn` 访问中国移动物联网能力开放平台 V5 接口。平台仅提供安全代理转发，不改变中国移动 V5 接口的请求方法、请求参数、响应结构和业务语义。
## 服务地址
客户侧统一使用：
```text
https://api.iotlcm.example.com
https://apiv3.5iot.cn
```
V5 接口的请求路径保持与中国移动官方接口一致，将官方域名替换为平台域名即可：
```text
https://api.iotlcm.example.com/v5/{官方接口路径}
https://apiv3.5iot.cn/v5/{官方接口路径}
```
例如，官方接口路径为 `/v5/ec/query/sim-basic-info` 时，客户侧请求路径为：
```http
POST https://api.iotlcm.example.com/v5/ec/query/sim-basic-info
POST https://apiv3.5iot.cn/v5/ec/query/sim-basic-info
```
平台会将该请求转发至：
@@ -64,7 +64,7 @@ https://api.iot.10086.cn/v5/ec/query/sim-basic-info
### 单卡基本信息查询
```http
POST https://api.iotlcm.example.com/v5/ec/query/sim-basic-info
POST https://apiv3.5iot.cn/v5/ec/query/sim-basic-info
```
请求参数：
@@ -82,7 +82,7 @@ POST https://api.iotlcm.example.com/v5/ec/query/sim-basic-info
```json
{
"transid": "YOUR_TRANSID",
"token": "YOUR_ACCESS_TOKENf3515b3bdaeca904dd2e904061b65e8153",
"token": "YOUR_ACCESS_TOKEN",
"iccid": "898608501624D0000009"
}
```
docs/openapi/operator/shared-token/index.md
+4 -4
View File
@@ -11,10 +11,10 @@ outline: deep
## 服务地址
```text
https://api.iotlcm.example.com
https://apiv3.5iot.cn
```
HTTP（`http://api.iotlcm.example.com`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
HTTP（`http://apiv3.5iot.cn`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
## 接口信息
@@ -52,7 +52,7 @@ POST /openapi/v3/query/operator-token
"data": {
"chanAlias": "中国移动物联网",
"chanKey": "channel_010",
"accessToken": "YOUR_ACCESS_TOKENf3515b3bdaeca904dd2e904061b65e8153",
"accessToken": "YOUR_ACCESS_TOKEN",
"tokenExpire": "2026-09-09 16:00:00"
},
"error": null
@@ -76,7 +76,7 @@ POST /openapi/v3/query/operator-token
```bash
curl --request POST \
--url https://api.iotlcm.example.com/openapi/v3/query/operator-token \
--url https://apiv3.5iot.cn/openapi/v3/query/operator-token \
--header 'Content-Type: application/json' \
--data '{
"appId": "7s9g2p5n8z1d4m6r",
docs/openapi/v3/common.md
+2 -2
View File
@@ -9,10 +9,10 @@ outline: deep
## 服务地址
```text
https://api.iotlcm.example.com
https://apiv3.5iot.cn
```
HTTP（`http://api.iotlcm.example.com`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
HTTP（`http://apiv3.5iot.cn`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
## 鉴权
docs/openapi/v3/index.md
+2 -2
View File
@@ -9,10 +9,10 @@ outline: deep
## 服务地址
```text
https://api.iotlcm.example.com
https://apiv3.5iot.cn
```
HTTP（`http://api.iotlcm.example.com`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
HTTP（`http://apiv3.5iot.cn`）仅为存量兼容保留，不做自动跳转，新接入请使用 HTTPS。
## 统一返回结构
docs/openapi/v3/token.md
+1 -1
View File
@@ -25,7 +25,7 @@ POST /openapi/v3/query/token
```json
{
"appKey": "YOUR_APP_ID",
"appSecret": "YOUR_APP_SECRETebdebae9763127943f097758e029a0fdbc"
"appSecret": "YOUR_APP_SECRET"
}
```