Contact Support

创建和管理 API 密钥（传统版）

更新

This is a Legacy article. If you are using the current Awardco 2.0 Interface, please search for the updated version to ensure accuracy.

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

 

什么是 API？

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

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

 

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

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

 

API 可以实现什么？

Awardco API 的常见用例包括：

  • 上传用户文件到 Awardco。
  • 获取 .csv 或 .json 格式的报告。
  • 自动化奖励和认可。
  • 检索社交动态信息以进行展示。
  • 与平台交互以创建应用程序。

 

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

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

 

虽然 API 提供了对 Awardco 平台的强大访问权限，但客户需对其使用负全部责任。

 

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

 

启用 API 密钥权限

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

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

 

image.png

 

访问 API 密钥管理工具

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

 

访问 API 密钥管理工具的步骤：

  1. 选择首页右上角的“管理员”按钮。
  2. 点击“设置”标签。
  3. 从左侧菜单点击“API 密钥”。

 

image.png



 

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

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

 

创建新的 API 密钥

创建新 API 密钥的步骤：

  1. 在 API 密钥页面点击“+ 新建 API 密钥”按钮。
  2. 输入密钥名称。
  3. 选择该密钥应拥有的权限。
    • 如果您正在为 Awardco 集成设置 API 密钥，请参见下方的集成所需权限部分。
  4. 设置密钥的有效期或到期日期。
    • 最大到期日期为从今天起三年内。建议定期更换 API 密钥。
  5. 点击“下一步”。
  6. 选择立即生成密钥，或安全地发送给其他人。
  7. 审查详情，点击“生成 API 密钥”或安全发送以完成操作。

 

Screenshot 2024-12-11 at 9.51.05 AM.png

 

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

 

管理 API 密钥

查看和编辑 API 密钥详情

查看 API 密钥详情步骤：

  1. 点击 API 密钥名称，打开详情窗口，显示：
  • 密钥名称。
  • 密钥的前六位数字。
  • 创建者名称。
  • 状态。
  • 权限。
  • 创建日期。
  • 到期日期。
  • 最后使用日期。

 

Screenshot 2024-12-05 at 9.29.42 AM.png

 

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

 

Screenshot 2024-12-05 at 9.32.19 AM.png

 

撤销 API 密钥

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

 

撤销 API 密钥的步骤：

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

 

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

 

Screenshot 2024-12-05 at 9.33.06 AM.png

 

重新发送 API 密钥

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

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

 

克隆 API 密钥

克隆 API 密钥的步骤：

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

 

image.png

 

查看已归档的密钥

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

 

Screenshot 2024-12-11 at 9.54.47 AM.png

 

从经典 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.

关于