Dai0814
19455e1cbc
Sync manuals, navigation and screenshots from open-source c8fa783 while preserving public README, LICENSE and history.
75 lines
4.7 KiB
Markdown
75 lines
4.7 KiB
Markdown
# API 凭证与执行日志
|
||
|
||
## 我的 API 凭证
|
||
|
||
**入口：** 左侧菜单 → **我的 API 凭证**。
|
||
|
||
|
||
|
||
页面显示本企业的企业 ID、企业名称、`appKey`（API 账号标识）和 `appSecret`（API 密钥），并提供复制按钮。接口鉴权和请求格式请配合 [OpenAPI 接口文档](/openapi/) 使用。
|
||
|
||
页面或旧截图可能将应用标识标成 `appId` 或显示“APPID复制成功”，当前复制操作实际取的是 `appKey`。请按下方说明及目标接口版本区分字段，不根据旧按钮文案替换请求参数。
|
||
|
||
**appKey ≠ appId**
|
||
|
||
- **`appKey`** 和 **`appSecret`** 仅用于调用 `/openapi/v3/query/token` 换取 token
|
||
- **`appId`**（客户组织编码，如 `CUS-202601-0001`）由 token 接口返回，调用其他接口时在请求体中传入
|
||
- 不要把 `appKey` 当作 `appId` 使用，两者是不同的概念
|
||
|
||
### 安全要求
|
||
|
||
- `appSecret` 等同接口密码，只能提供给获准的开发和运维人员。
|
||
- 不要把凭证写入前端代码、公开仓库、工单正文、聊天截图或日志。
|
||
- 服务端应通过环境变量或密钥管理服务保存凭证。
|
||
- 不同环境不要共用同一份配置文件。
|
||
- 怀疑泄露时立即停止相关调用并联系平台支持更换凭证。
|
||
|
||
复制后粘贴到配置前，检查是否带入多余空格或换行。获取 token 失败时，先核对本企业的 appKey 与 appSecret 是否配套；后续请求失败时，按对应版本的接口文档核对 token、appId 和请求地址，不要混用不同版本的鉴权参数。
|
||
|
||
## 执行日志
|
||
|
||
**入口：** 左侧菜单 → **执行日志**。
|
||
|
||
|
||
|
||
批量续费、套餐变更、加油包、重启、停复机、划拨、达量断网等任务提交后，均应通过执行日志确认最终结果。
|
||
|
||
### 查询批次
|
||
|
||
可按关键字、批次编号、批次类型、发起渠道、操作规模、输入方式、异步处理状态和创建时间查询。
|
||
|
||
|
||
|
||
列表显示：
|
||
|
||
- 批次编号和批次类型。
|
||
- 来源方式，如 Excel 或批量输入。
|
||
- 发起渠道（如 Web、小程序或接口）及操作规模（单卡、批量）；旧记录可能显示为未知，不能仅凭总数量推断来源。
|
||
- 运行结果和异步状态。
|
||
- 总数量、开始时间和结束时间。
|
||
|
||
点击批次编号可查看逐卡明细，包括行号、ICCID、MSISDN、IMSI、明细状态和异常原因。点击“查看”可查看批次概要、失败原因、源文件、结果文件和处理时间。
|
||
划拨批次的概要还显示划拨单位和接收单位；若目标按每张卡分别指定，接收单位会提示在逐卡明细中查看。核对划拨结果时，先看批次单位，再查看每张卡的接收方和失败原因。
|
||
|
||
### 处理失败任务
|
||
|
||
1. 用提交时记录的批次号查询。
|
||
2. 核对批次和逐卡状态。“待处理”“处理中”或“待核查”尚无确定结果，应先等待或请平台核实，不要重复提交。
|
||
3. 点击批次号查看失败卡及异常原因。
|
||
4. 有结果文件时下载核对；文件待生成、生成失败或暂无文件时，先查看逐卡明细。无文件或文件生成失败不代表卡片执行失败。
|
||
5. 原批次结束后，只对确认失败且可修正的卡，核实当前卡片、套餐或归属状态后修正原因并重新提交，不要整批重复提交。划拨和出库还需按[结果有误时的处理步骤](./business-operations#划拨或出库结果有误时)核对。
|
||
6. 无法处理的上游错误通过工单反馈，并附批次号和失败原因。
|
||
|
||
常见失败原因包括卡号不属于当前企业、卡状态不允许办理、套餐不匹配、余额不足、模板字段错误、上游超时或重复业务仍在处理中。
|
||
|
||
## 接口资源与权限组（管理员）
|
||
|
||
获授权管理员可通过“接口资源”维护接口名称、权限标识、请求方法、路径、版本及启停状态；通过“API 权限组”维护组名称、编码、状态和包含的接口资源。具体页面名称与分组以当前菜单为准。
|
||
|
||
1. 在接口资源中按名称、版本和状态查询目标接口，确认方法、路径及权限标识与已部署接口一致。
|
||
2. 在权限组中新增或编辑所需资源集合，核对启用状态后保存。
|
||
3. 根据企业实际授权关系核对可访问范围；不要将持有 API 密钥理解为可调用全部接口。
|
||
4. 变更后由获授权的接口调用方按对应 OpenAPI 文档验证，保留脱敏错误信息用于排查。
|
||
|
||
配置资源或权限组不会自动新增后端接口实现。此类权限维护与普通用户复制本企业 API 凭证是不同操作。
|