管理凭证
凭证是用于通过网关进行 API 调用的身份验证令牌。本指南介绍如何在应用程序中管理凭证。
先决条件
创建一个凭证
1、登录开发者门户。 2. 导航至 我的应用程序 并选择你的应用程序。 3. 转至 凭证 选项卡（或特定身份验证类型的选项卡）。 4. 单击“添加凭证”（或“添加密钥”、“添加 OAuth 客户端”，具体取决于类型）。
密钥认证
创建密钥认证凭证时：
| 领域 | 必填 | 描述 |
|---|---|---|
| 姓名 | 是的 | 凭证的描述性名称。 |
| 描述 | 没有 | 可选描述。 |
自动生成 API 密钥。立即复制并安全地存储密钥，因为它仅在创建时完整显示。
要在 API 请求中使用密钥，请将其包含在请求标头中：
curl "https://gateway.example.com/api/endpoint" \
-H "apikey: <your-api-key>"
基本身份验证
创建基本认证凭证时：
| 领域 | 必填 | 描述 |
|---|---|---|
| 姓名 | 是的 | 凭证的描述性名称。 |
| 用户名 | 是的 | HTTP 基本身份验证的用户名。 |
| 密码 | 是的 | HTTP 基本身份验证的密码。 |
要在 API 请求中使用基本身份验证：
curl "https://gateway.example.com/api/endpoint" \
-u "username:password"
OAuth (DCR)
通过动态客户端注册创建 OAuth 凭证时：
| 领域 | 必填 | 描述 |
|---|---|---|
| 姓名 | 是的 | 凭证的描述性名称。 |
| 身份提供商 | 是的 | 选择管理员配置的DCR提供商。 |
| 重定向 URI | 是的 | OAuth 流程的回调 URL。 |
门户向身份提供商注册客户端并返回：
- 客户端 ID：在 OAuth 流程中 使用此 ID。
- 客户端密钥：在 OAuth 流程中使用此密钥。立即复制。
要使用 OAuth 凭证：
- 使用客户端 ID 和密钥向身份提供商请求访问令牌。
- 在 API 请求中包含访问令牌：
curl "https://gateway.example.com/api/endpoint" \
-H "Authorization: Bearer <access-token>"
查看凭证
导航到 我的应用程序 > 选择应用程序 > 凭证 选项卡可查看与该应用程序关联的所有凭证。敏感值（API 密钥、密码、客户端机密）在创建后会被屏蔽。
重新生成一个凭证
如果凭证受到威胁或者你需要轮换它：
- 导航至应用程序中的凭证。
- 单击“重新生成”。
- 确认操作。
旧的凭证值立即失效。复制并安全地存储新值。
备注
重新生成凭证会使之前的值立即失效。所有使用旧凭证的 API 请求都将失败。在重新生成之前，使用新的凭证更新你的应用程序。
对于 OAuth 凭证，秘密轮换仅在使用 HTTP 桥 DCR 提供程序时可用。 OIDC 类型 DCR 提供程序不支持客户端密钥轮换。
删除一个凭证
- 导航至应用程序中的凭证。
- 单击删除。
- 确认删除。
对于 OAuth 凭证，删除凭证还会从身份提供者中删除已注册的客户端。
每个应用程序有多个凭证
一个应用程序可以有多个不同类型的凭证。这在以下情况下很有用：
- API 产品支持多种身份验证方法，并且你希望对不同的集成使用不同的方法。
- 你需要在删除旧凭证之前创建一个新的凭证，从而在不停机的情况下轮换凭证。