API 认证授权
Version 24.3.9111
Version 24.3.9111
API 认证授权
用户
知行之桥 使用基于身份验证令牌的身份验证来控制每个用户对 API 的访问。 Authtoken 是唯一的、随机生成的标识符,用户可以使用它向 API 进行身份验证。 Authtokens 还代表用户当前的权限。
Authtokens 允许使用任何主要的身份验证方案进行连接。 例如,要使用 HTTP Basic 身份验证,请在 User 消息头中设置用户名,并在 Password 消息头中设置用户相应的 authtoken。 有关对 API 进行身份验证的更多信息,请参阅身份验证。
添加用户
要添加用户,请导航到端口的 用户 选项卡,然后单击 添加。 在出现的对话框中,输入以下信息:
- 名称:输入用于 HTTP 身份验证的用户名。
- 权限:选择允许用户访问的 HTTP 方法:GET、POST、PUT/PATCH/MERGE 或 DELETE。 它们分别对应于 SELECT、INSERT、UPDATE 和 DELETE 语句。
- 最大请求:输入该用户每小时的最大请求数。 值为 0 允许用户每小时无限制访问。
- 最大并发请求:输入可以同时发送的最大请求数。 值 0 允许用户无限并发请求。
注意:用户特定的设置会覆盖服务器范围的 API 限制设置。 用户设置之一的空值使用服务器默认值。
配置用户数据库
知行之桥默认将用户信息存储在SQLite数据库中。 还可以将用户信息保存到选择的数据库中。 如果使用嵌入式服务器,请在 Web.config 文件的 connectionStrings
元素中指定缓存数据库的连接字符串。 否则,请参阅托管应用程序的服务器的文档。
验证
用户通过向请求提供身份验证令牌来访问 API 资源。 可以在 API 端口设置窗格的 用户 选项卡上管理用户和身份验证令牌。
用户调用API之前,还需要设置可信连接IP地址。 这些设置可在 API 端口设置窗格的 服务器 选项卡上找到。 默认情况下,所有 IP 地址都受到限制。
在基本身份验证中使用身份验证令牌
使用基本身份验证时,输入用户的身份验证令牌作为密码。
在 HTTP 消息头中使用身份验证令牌
添加 HTTP 消息头 x-cdata-authtoken
,将所需的身份验证令牌作为 HTTP 请求的一部分。
使用身份验证令牌作为查询字符串参数
要允许端口在查询字符串参数中传递身份验证令牌,请打开 API 端口设置窗格的 服务器 选项卡,然后在 高级设置 部分中选择 允许在 URL 中使用身份验证令牌。
启用此功能后,可以将身份验证令牌指定为 @authtoken
参数的值,该参数可以作为 HTTP 表单发布数据或查询参数的一部分提供。