Files
iotlcm/docs/manual/web/api-and-logs.md
T
2026-10-26 15:30:14 +08:00

54 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# API 凭证与执行日志
## 我的 API 凭证
**入口:** 左侧菜单 → **我的 API 凭证**。
![我的 API 凭证页面](/images/manual/api-credentials-entry.png)
页面显示本企业的企业 ID、企业名称、`appKey`(API 账号标识)和 `appSecret`(API 密钥),并提供复制按钮。接口鉴权和请求格式请配合 [OpenAPI 接口文档](/openapi/) 使用。
::: warning appKey ≠ appId
- **`appKey`** 和 **`appSecret`** 仅用于调用 `/openapi/v3/query/token` 换取 token
- **`appId`**(客户组织编码,如 `CUS-202601-0001`)由 token 接口返回,调用其他接口时在请求体中传入
- 不要把 `appKey` 当作 `appId` 使用,两者是不同的概念
:::
### 安全要求
- `appSecret` 等同接口密码,只能提供给获准的开发和运维人员。
- 不要把凭证写入前端代码、公开仓库、工单正文、聊天截图或日志。
- 服务端应通过环境变量或密钥管理服务保存凭证。
- 不同环境不要共用同一份配置文件。
- 怀疑泄露时立即停止相关调用并联系平台支持更换凭证。
复制后粘贴到配置前,检查是否带入多余空格或换行。接口返回鉴权失败时,先核对企业对应的 appId 与 appSecret 是否配套,再检查签名、时间戳和请求地址。
## 执行日志(暂未开放)
**入口:** 左侧菜单 → **执行日志**。
批量续费、套餐变更、加油包、重启、停复机、划拨、达量断网等任务提交后,均应通过执行日志确认最终结果。
### 查询批次
可按关键字、批次编号、批次类型、异步处理状态和创建时间查询。列表显示:
- 批次编号和批次类型。
- 来源方式,如 Excel 或批量输入。
- 运行结果和异步状态。
- 总数量、开始时间和结束时间。
点击批次编号可查看逐卡明细,包括行号、ICCID、MSISDN、IMSI、明细状态和异常原因。点击“查看”可查看批次概要、失败原因、源文件、结果文件和处理时间。
### 处理失败任务
1. 用提交时记录的批次号查询。
2. 确认批次已结束,避免把“处理中”误判为失败。
3. 点击批次号查看失败卡及异常原因。
4. 下载结果文件,修正卡号、状态、套餐或模板数据。
5. 只重提失败且可修正的卡,不要整批重复提交。
6. 无法处理的上游错误通过工单反馈,并附批次号和失败原因。
常见失败原因包括卡号不属于当前企业、卡状态不允许办理、套餐不匹配、余额不足、模板字段错误、上游超时或重复业务仍在处理中。