API¶
除了客户端 SDK 之外，Authany 还提供以下 API，方便您在应用中集成身份验证和用户管理功能。
这些 API 都位于您应用的端点上。除非您设置了自定义域名，否则默认端点为 https://[myapp].authgear.cloud。[myapp] 是您的项目名称。
除非另有说明，本文提到的所有路径都是相对于您应用端点的相对路径。
Authany 提供以下几组 API：
- OAuth 2.0 and OpenID Connect：用于与 OIDC 客户端对接
- Admin API：供您的服务器通过 GraphQL 端点管理用户。
- User Import API：用于将用户从其他系统批量导入 Authany 项目的 API。
- User Export API：可将 Authany 项目中的用户数据导出为 CSV 或 ndjson 格式文件的 API。
- Authentication Flow (Auth Flow) API：用于开发自定义的 Web 或移动原生身份验证界面，以替代 Authany 提供的默认界面。
- Resolver Endpoint：供 API 网关或服务器检查请求头中访问令牌或 Cookie 的有效性。
以下列出了上述各组 API 对应的所有特殊路径。
OAuth 2.0 and OpenID Connect¶
有关 OIDC API 端点的更多信息，请参阅以下章节，或任意一篇 Regular Web App 快速入门指南。
OAuth 2.0 and OpenID Connect (OIDC)
相关 URL 如下：
/.well-known/openid-configuration
该端点会返回一个 JSON 文档，其中包含您 Authany 项目的 OpenID Connect 配置，包括授权端点、令牌端点和 JWKs 端点。以下是效果示例。/.well-known/oauth-authorization-server
该端点会返回一个 JSON 文档，其中包含您 Authany 项目的授权服务器元数据，包括授权端点、令牌端点和 JWKs 端点。以下是效果示例。/oauth2/userinfo
UserInfo 端点是一个 OAuth 2.0 受保护资源，用于返回已通过身份验证的终端用户的声明。当客户端出示有效的访问令牌时，该端点会以 JSON 对象的形式返回这些声明。这些声明同时也是用户资料的属性。
Admin API¶
有关 Admin API 的更多详情，请参阅以下文档：
Admin API 的路径为：
/_api/admin/graphql
User Import API¶
要了解如何使用 User Import API，请参阅以下文档页面：
Import Users using User Import API
User Import API 的路径：
/_api/admin/users/import
使用此端点导入用户。
/_api/admin/users/import/{ID}
使用此端点查询现有用户导入任务的状态。
User Export API¶
有关如何使用 User Export API 的详细说明，请参阅以下文档：
Export Users using the User Export API
User Export API 的路径：
/_api/admin/users/export
使用上述端点启动用户导出流程。
/_api/admin/users/export/{Task ID}
使用上述端点检查现有导出流程是否已完成，并获取导出文件的下载 URL。
Authentication Flow API¶
关于 Authentication Flow API 的详细介绍，请参阅以下文档：
Authentication Flow API 的路径为：
/api/v1/authentication_flows
Resolver Endpoints¶
解析器端点位于以下 URL：
/_resolver/resolve
该端点用作解析器，用于检查请求头中的访问令牌或 Cookie。将传入的 HTTP 请求转发到该端点后，解析器会在响应中添加 x-authgear- 请求头。
如需查看 x-authgear- 请求头的完整列表，请参阅规范中的这里。
实现示例请参阅这里。
如果您选择使用 Resolver Endpoints 而不是 JWT 令牌来验证每个 API 请求，请查看以下教程，了解具体做法：
Forward Authentication to Authany Resolver Endpoint
其他特殊 URL¶
以下是另外两个 URL
/
该端点是 Web UI 的入口。如果您想测试自己的配置，可以访问它（仅适用于自定义域名）。但请注意，这不是授权端点，您必须使用我们的 SDK 来发起身份验证。/settings
该 URL 指向 Authany 提供的默认用户设置界面。