Contact Support

创建和管理 API 密钥

更新

Awardco 平台中的手动任务，例如上传用户文件或生成报告，可能既繁琐又耗时。通过使用 API 密钥，您可以自动化这些流程，节省时间和精力。本文介绍了什么是 API 密钥，它们的功能，以及如何通过 API 密钥管理工具在您的组织中使用它们。

注意： 您为 API 密钥选择的权限取决于您使用的 Awardco 产品：

  • Awardco Recognition：您可能需要广泛的权限，包括社交动态、认可发布和报告功能。
  • Awardco Engage：由于 Engage 侧重于员工调查，您的 API 需求通常仅限于用户管理，以保持调查受众的最新状态。

 

  1. 什么是 API？
  2. 启用 API 密钥权限
  3. 访问 API 密钥管理工具
  4. 创建新的 API 密钥
  5. 管理 API 密钥
  6. 从经典 API 密钥过渡
  7. 集成所需权限

 

什么是 API？

API（应用程序编程接口）是两个程序之间通信的一种方式。它提供了一组命令和请求，程序（例如 Awardco）可以接受来自外部来源的指令。大多数移动应用使用 API 与其母系统通信。

Awardco 的 API 使用 HTTP 协议，与网站使用的协议相同，这简化了通信，并允许直接从浏览器发起 API 调用。

Awardco 的 API 支持两种主要请求类型：

  • GET：从数据库请求信息，例如以 .csv 或 .json 格式检索报告。
  • POST：更新数据库中的信息。例如，允许您更新用户、发布认可或管理奖励。

 

API 可以实现什么？

常见用例包括：

  • 用户管理：同步员工数据（Engage 和 Recognition 都必需）。
  • 自动化：自动化奖励和认可（仅限 Recognition）。
  • 社交动态：检索外部显示用的动态信息（仅限 Recognition）。

 

要通过 API 发送文件，文件必须可访问且编码正确。主要有三种处理方法：

  1. 将文件存储在 FTP 或公开访问的服务器上。
  2. 使用 API 服务（例如 Postman）构建请求。
  3. 使用编程语言如 C#、cURL 或 JavaScript 发送请求。

 

虽然 API 为访问 Awardco 平台提供了强大能力，但客户需对其使用负全责。

 

欲了解更多信息，请访问我们的公共 API 文档。

 

启用 API 密钥权限

默认情况下，只有超级管理员用户可以管理 API 密钥。若要允许其他角色管理和创建 API 密钥：

  1. 在主页上，选择左侧导航菜单底部的管理员按钮。
  2. 选择“用户”，然后从左侧导航菜单选择“权限”。
  3. 点击您想编辑的角色旁的三点图标，选择编辑。
  4. 进入权限设置，勾选“API 密钥”旁的复选框。
  5. 点击保存并应用。

 

 

访问 API 密钥管理工具

Awardco 提供专门的 API 密钥管理工具，允许您管理针对不同操作（如发送认可、获取动态或创建用户）的特定 API 密钥。Awardco 不使用单一的万能 API 密钥，而是根据您的需求将密钥分解为不同操作。

 

访问 API 密钥管理工具的方法：

  1. 在主页上，选择左侧导航菜单底部的管理员按钮。
  2. 选择“平台”，然后依次选择“集成”和“API 设置”。

 



 

在 API 密钥管理工具中，您可以：

  • 查看和管理针对不同任务的特定 API 密钥（例如发送认可、生成报告）。
  • 为组织中可以管理 API 密钥的人员分配角色和权限。
  • 追踪每个 API 密钥的创建者及创建时间。
  • 确保 API 密钥经过哈希和加盐处理以保障安全（不会以明文存储）。
  • 根据需要删除 API 密钥。
  • 注意，模拟用户身份无法生成 API 密钥。
  • 安全地将 API 密钥发送给受信任的人员。

 

创建新的 API 密钥

创建新 API 密钥的步骤：

  1. 在 API 密钥页面点击“+ 新建 API 密钥”按钮。
  2. 输入密钥名称。
  3. 选择该密钥应拥有的权限。
  • 对于 Recognition 客户：选择与您的集成相关的权限（例如 ScreenCloud 的自定义动态）。
  • 对于仅使用 Engage 的客户：通常只需与用户数据传输相关的权限，以保持调查受众的最新状态。建议仅选择：
    • 激活用户、归档用户、创建用户、导入用户、头像、更改密码、用户存在查询及用户列表权限。
  1. 设置密钥的过期时间或日期。
    • 最长过期时间为从今天起三年内。建议定期更换 API 密钥。
  2. 点击下一步。
  3. 选择立即生成密钥或安全地发送给其他人。
  4. 审核详情，点击生成 API 密钥或安全发送以完成流程。

 

 

重要提示：生成后请立即复制并安全保存 API 密钥。出于安全考虑，密钥不会再次显示。有关 API 密钥最佳实践和提示的更多信息，请参阅此支持文章。

 

管理 API 密钥

查看和编辑 API 密钥详情

要查看 API 密钥详情，点击密钥名称打开详情窗口，显示内容包括：

  • 密钥名称。
  • 密钥前六位数字。
  • 创建者名称。
  • 状态。
  • 权限。
  • 创建日期。
  • 过期日期。
  • 最后使用日期。

 

 

要编辑 API 密钥的名称或过期日期，点击编辑并进行修改。完成后保存更改。

 

 

撤销 API 密钥

撤销 API 密钥将永久停用该密钥，使任何相关集成无法使用。此操作不可撤销。

 

撤销 API 密钥的步骤：

  1. 点击密钥旁的三点图标。
  2. 选择“撤销”。
  3. 点击“撤销 API 密钥”确认操作。

 

撤销的密钥将移至“已归档”标签页。

 

 

重新发送 API 密钥

如果 API 密钥显示“未接受”状态或未在 24 小时内被接受，您可以重新发送该密钥。

  1. 点击密钥旁的三点图标。
  2. 选择“重新发送”。API 密钥将发送至创建时指定的电子邮件地址。

 

克隆 API 密钥

克隆 API 密钥的步骤：

  1. 点击密钥旁的三点图标，选择“克隆”。
  2. 根据需要更新名称、权限或过期日期。
  3. 按照“创建新的 API 密钥”中描述的相同步骤生成或发送密钥。

 

 

查看已归档的密钥

要查看已撤销或归档的 API 密钥，请导航至 API 密钥设置中的“已归档”标签页。撤销的密钥无法恢复，但可以克隆以创建副本。

 

 

从经典 API 密钥过渡

虽然经典 API 密钥目前仍可使用，但我们建议迁移到新系统，以获得更高的安全性和更好的集成控制。

 

查找您的经典 API 密钥

您的经典 API 密钥已移至新的 API 密钥管理页面。您现在可以在 API 设置页面底部找到它。

 

 

如何从经典 API 密钥迁移

安全过渡经典 API 密钥的步骤：

  1. 创建新的权限密钥：按照上述“创建新的 API 密钥”步骤，为每个集成生成单独的 API 密钥。确保每个密钥仅拥有其集成所需的特定权限。
  2. 更新您的集成：将每个集成中的经典 API 密钥替换为相应的新权限密钥。
  3. 删除您的经典 API 密钥：所有集成更新完成后，点击 API 设置页面底部的“删除经典 API 密钥”按钮。

 

集成所需权限

以下是使用 API 密钥的集成及其所需权限列表：

 

 

 

If you have any questions, please contact Awardco Admin Support.

关于