配置测试 knowledge base API 或将应用程序连接到它所需的身份验证。
知识库 API 请求使用不记名令牌身份验证。使用经过身份验证的用户令牌进行短期测试,或为应用程序或集成配置技术帐户。
准备事项
请确保:
- 您的组织有权访问 知识库。
- 您有权访问工作流程所需的 API 资源。
- 如果您正在设置应用程序集成,您可以访问 Adobe Developer Console。
API 访问权限不会覆盖 知识库 权限。经过身份验证的身份必须有权访问应用程序请求的收藏集、文档和操作。
选择身份验证方法
使用与您开发阶段相匹配的身份验证方法。
| 用例 | 身份验证 |
|---|---|
| 测试请求或探索 API | 已验证用户的 Bearer 令牌 |
| 构建应用程序或集成 | 技术帐户 |
用户 Bearer 令牌
经过身份验证的用户持有者令牌适用于测试 API 请求,包括通过 API 参考发起的请求。
该令牌代表已登录的用户,有效期为 24 小时。使用该令牌发出的请求具有该用户可用的相同 知识库 访问权限。
获取用户不记名令牌后,将其包含在每个请求中:
Authorization: Bearer <access-token>
您还可以将该令牌与交互式 知识库 API 参考文档一起使用,以测试可用的端点。
从检索您已有访问权限的资源的操作开始。成功的响应确认令牌已被接受,且经过身份验证的身份标识可以访问该资源。
请勿基于用户持有者令牌构建持久化的应用程序集成。
技术帐户
对于需要在无交互式用户会话情况下进行身份验证的应用程序和集成,请使用技术帐户。
技术帐户通过 Adobe Developer Console 进行配置。按照技术帐户设置流程创建应用程序所需的凭据。
创建技术帐户后,返回此页面验证您对 Knowledge Base API 的访问权限。
了解 API 权限
身份验证可确定发出 API 请求的身份。授权决定该身份可以执行的操作。
例如,经过身份验证的身份可能能够检索一个集合但无法检索另一个集合,或者可能无权访问管理员级别的资源。
如果身份验证成功但操作被拒绝,请在将响应视为身份验证失败之前,先验证经过身份验证的身份是否有权访问请求的资源。
验证您的 API 访问权限
配置身份验证后:
- 获取访问令牌。
- 向经过身份验证的身份可访问的资源提交请求。
- 确认 API 返回预期的响应。
- 继续 API 入门工作流程。