本文讲解如何在 EloView 4 的 DevZone 中使用 API
下面描述了如何在 Elo DevZone 中使用 API。本文涵盖以下内容:
1. 生成 OAuth 凭据
2. 获取身份验证令牌
3. 授权 API
4. 获取 OrgId:
5. 运行 API
1. 生成 OAuth 凭据
OAuth(开放授权)是一种开放标准授权协议,提供应用程序“安全指定访问”的能力。这将用于获取授权令牌。
a. 登录至 EloView 网站:https://secure.eloview.com/
b. 点击 个人资料图标
c. 点击 生成 OAuth 凭据
d. 复制并粘贴 OAuth 凭据(clientID 和 clientSecret)到记事本,然后 点击 确定
2. 获取身份验证令牌
这是用于对云中的应用程序进行用户或进程身份验证的过程。用户的应用向身份验证服务发送请求,确认用户身份并发放令牌。然后用户就可以访问应用程序。
a. 点击 API 选项卡
b. 展开身份验证网格并 点击 “试试这个” 按钮(如下面图像所示),这将使您能够输入必填参数的值,并在 API 框底部显示执行按钮。
c. 添加 Client Id(路径参数)和 clientsecret 作为主体参数(从 OAuth 凭据/第 1 步中获得),然后 点击 执行。
d. 这将生成能够用于进一步操作的身份验证令牌。
e. 检查响应主体并 复制 响应中的 access_token。这将用作访问其他 API 的 Bearer 令牌。响应将如下图所示。
3. 授权 API
访问令牌是应用程序代表用户发出 API 请求所使用的东西。访问令牌表示特定应用程序访问用户数据特定部分的授权。
a 点击 授权按钮,位于屏幕右上角。
b 这将打开一个对话框,我们可以在此添加访问令牌的值以授权 API。
c. 输入 bearer & 粘贴 访问令牌到输入框。
d. 点击 授权按钮 & 关闭 弹出窗口
e. 现在用户已被授权访问任何可用的 API。
4. 获取 OrgId:
OrgId(组织 ID)将用于在 Dev-zone 执行不同的 API 操作。
a. 点击 齿轮图标
b. OrgId 位于右下角
5. 运行 API
一旦完成授权,我们可以从 Dev-zone 运行 API。
a. 展开 模块标题,例如内容 / 获取内容列表
b. 点击 试试这个
c. 输入 ORG ID
d. 选择 执行
结果应如下所示:
Please report any broken links by emailing support@elotouch.com and include a link to the knowledge article