API 用户中心

最近更新时间:2023-06-08 14:47:58

我的收藏
腾讯云数据连接器会根据用户已经配置完成的 API 服务(包括其 Endpoint)生成用户可以调用的开放 API。在 API 用户中心中,我们将会帮助您更好的管理每个 API 服务的用户,以及分配用户对于 API 的使用权限。
API 用户中心 首页是以列表的形式展示当前可以配置的所有 API 服务信息,但是展示维度与“API管理”略有不同。



用户管理

用户管理功能允许 API 的提供者帮助其用户添加管理账号、分配权限,并获取请求 API 时所需要的所有必要信息。
API 服务提供方将会以类似管理者的视角去统一管理用户,允许查看用户的 OAuth 信息并分享给用户以便用户调用,或者进行用户的封禁和启用。


添加用户的时候需要提供以下用户信息,以便能够更好的记录和维护。同时,此处的用户名称和用户密码也将作为对应 API 服务的 Basic Auth 验证方式。


当创建好用户之后,则可以通过查看详细信息按钮获取到用户的 client ID、client Secret 等内容。


说明
当前仅支持 API 服务提供方手动帮助客户添加成员信息和账户信息,客户的自助注册的能力暂不支持。

使用流程

步骤1:创建 API 服务及其 API Endpoint

具体操作请参见 创建 API 服务创建 API Endpoint

步骤2:获取 API 请求地址

1. 在 API 服务列表中获取 API 服务的域名。


2. 在 API Endpoint 列表中获取需要请求的 Endpoint 路径。
获取路径


3. 将 Endpoint 路径拼接在 API 服务域名后面,即可获取完整的 API 请求域名。请将此域名保存,步骤4 中会用到

步骤3:获取用户请求 API 的权限

1. API 用户中心 首页单击用户管理


2. 单击添加用户,并配置以下信息。



3. 帮助用户填写必要信息,并选择需要访问的 API 服务名称。


4. 绑定好 API 服务之后,返回用户管理列表获取此用户的 OAuth 信息(当前系统会默认给添加的用户进行自动审批,所以无需手动审批操作),并复制保存 OAuth 的 Token 获取地址、Client ID、Client Secret 等信息,连同用户的账号和密码一同分享给用户。



步骤4:从用户侧调用 API(以 postman 为例)

API 服务无需验证的情况:

API 服务需要 Basic Auth 的情况:

API 服务需要 OAuth2.0 的情况:
1. 在用户信息处获取 Client ID 和 Client Secret,在待访问的 API 服务页面获取 Access Token URL。
获取 OAuth 信息
获取 token 地址
![获取OAuth信息](https://qcloudimg.tencent-cloud.cn/raw/1af24df69318189138461b114fec41cb.png)

获取token地址

token 地址如下:


2. 复制之后,在 postman 中创建一个新的请求,填写入上方的 token 获取地址并使用“GET”方法(此处的鉴权方式应为“NoAuth”)。随后选择 Params 标签页,输入 client 信息。输入方式:
第一列:key 为 client_id,value 为从上方复制的 Client ID 对应的内容。
第二列:key 为 client_sectet,value 为从上方复制的 Client Secret 对应的内容。


3. 单击 send,从界面下方的“body”处复制“access_token”字段的值。此即为本次调用时需要用到的 Token 信息。


4. 重新打开一个请求界面,填入需要请求的 API 域名,并选择 Bearer Token 模式。在右侧的“Token”处输入前面获得的 Token,单击 send,即可看到访问结果。