API访问凭证
对UC API发出的每个HTTP请求都必须经过身份认证。 此操作是为了保证访问服务的客户端是否为系统已登记的用户。 在身份认证的过程中, 使用OAuth2.0协议。 在调用API之前, 您需要从UC企业管理平台中获得企业级AccessKey ID 与AccessKey Secret(“或者从UC系统管理平台中获取系统级AccessKey ID 与AccessKey Secret”), 用于申请访问 token。 一个企业管理平台或一个系统管理平台只能申请一组AccessKey ID 与AccessKey。
概述
由于UC4X的web管理平台有2个入口,分别是系统管理平台和企业管理平台,因此api接口根据用途也分为了系统级接口和企业级接口。
请注意:当你在调用接口前,需分辨清楚这2类接口,避免使用了错误的AccessKey ID 与AccessKey Secret获取到了和当前调用的API接口所不匹配的token,导致接口调用出错。
1)系统级接口:系统管理平台web端功能对应的API接口统称为系统级接口,即admin账户登录的网页端,地址示例为https://x.x.x.x/admin/login(注意:地址中是/admin)。仅当你需要通过API接口调用系统管理平台web端功能时,再使用该web端上提供的AccessKey ID 与AccessKey Secret。如下图所示
2)企业级接口:企业管理平台web端功能对应的API接口统称为企业级接口,即单租户9999账户或多租户企业管理员账户登录的网页端,地址示例为https://x.x.x.x/manager/login(注意:地址中是/manager)。仅当你需要通过API接口调用企业管理平台web端功能时,再使用该web端上创建应用后提供的AccessKey ID 与AccessKey Secret。如下图所示
鉴权KEY获取流程详解
企业级AccessKey ID 与AccessKey Secret获取方法
1)访问企业管理平台网址(https://x.x.x.x/manager/login,x.x.x.x为服务器ip或已配置给服务器的可解析域名),登录企业管理员账号(账号和密码以实际部署情况为准)
2)登录成功后,找到应用管理--创建应用,自定义命名应用名称后,点击保存。
2)保存创建成功后,是否立即编辑应用,点击确定,即可获取到应用凭证AccessKey ID 与AccessKey Secret。
注意:创建应用成功后,默认为不启用状态,需要在应用管理展示页中手动启用应用,启用后对应的应用凭证才生效可用。
系统级AccessKey ID 与AccessKey Secret获取方法
1)访问系统管理平台网址(https://x.x.x.x/admin/login,x.x.x.x为服务器ip或已配置给服务器的可解析域名),登录系统管理员admin账号(密码以实际部署情况为准)
2)登录成功后,找到系统配置-安全配置-鉴权管理,启用系统管理API鉴权,即可获取到AccessKey ID 与AccessKey Secret。
流程说明
用户申请访问 token 和发起请求的流程如下:
1、 第三方应用服务器向UC API服务器发起申请访问 token 请求并且携带Client ID(即AccessKey ID )和Client Secret(即与AccessKey Secret)
2、UC API服务器验证Client ID和Client Secret信息是否正确
3、 验证成功后返回访问 token
4、第三方应用服务器发起业务请求, 并且携带访问 token
5、UC API服务器验证是否存在访问令牌, 然后验证访问令牌的有效性。
6、转发请求给UC业务服务器
7、UC业务服务器将处理后的结果返回给UC API服务器
8、UC API服务器将响应结果透传给第三方应用服务器
示例代码参考
Java示例代码可访问以下链接下载获取:
Postman示例模板可访问以下链接下载获取: