Contact Support

如何设置自定义动态源 API

更新

自定义动态源 API 允许您按元数据筛选员工表彰动态，添加收件人标签，并自定义表彰显示。它通常与 ScreenCloud 一起使用，但也可以独立设置。有关 ScreenCloud 集成，请参见 本文。

 

对于直接设置自定义动态源 API 的客户，以下是帮助您配置的分步指南。

 

  1. 访问 API 设置
  2. 配置筛选字段（平台内）
  3. 选择元数据标签（可选）
  4. 启用错误通知
  5. 配置 API（元数据筛选）
  6. 测试与故障排除
  7. 有用资源

 

访问 API 设置

要开始使用自定义动态源 API，请登录您的 Awardco 管理门户并访问所需的配置设置。

  1. 登录您的 Awardco 账户。
  2. 选择左侧导航菜单底部的“管理员”按钮。
  3. 在左侧导航菜单中依次选择“平台”、“集成”、“API 设置”。
  4. 点击“API 配置”标签。

这将打开页面，您可以在此配置平台内设置和自定义动态源所需的 API 配置。

 

配置筛选字段（平台内）

筛选字段允许您根据元数据字段（如地点、部门或您组织相关的其他类别）控制表彰的筛选方式。此筛选确保仅显示符合特定条件的表彰。配置筛选字段的方法如下：

  1. 选择一个将作为筛选器的元数据字段。例如，如果您的公司有多个办公地点，可以使用“地点”元数据字段。
  2. 点击“保存更改”。

 

 

示例：

对于在不同城市设有办事处的公司，选择“地点”作为筛选字段可让您根据特定地点显示表彰，例如“伦敦”或“纽约”。

 

 

注意：筛选字段指定元数据字段（例如“地点”），稍后您将在 API 中定义用于筛选的具体值。

 

选择元数据标签（可选）

您可以通过显示额外的元数据（如部门或职位）来增强表彰动态。配置元数据标签的方法：

  1. 在子标签 1 和子标签 2 下，选择您希望显示的元数据字段。常见示例包括部门和职位。
  2. 例如，选择部门和职位可能会显示“销售部”和“客户经理”等详细信息。

 

此步骤为可选，但可以为您的表彰动态提供更多上下文信息。

 

 

 

启用错误通知

为确保设置顺利运行，建议启用错误邮件功能。如果自定义动态源出现无效配置或缺失元数据等问题，该功能会通知您。

  1. 在设置中找到“发送错误邮件”选项。
  2. 启用此功能以接收错误通知。

 

如果您已知存在正在处理的问题，可以暂时禁用错误邮件。

 

配置 API（元数据筛选）

平台内设置配置完成后，您需要在 API 调用中使用 metadataFilter 请求参数定义具体的筛选值。

  • 平台内的元数据筛选设置决定用于筛选的字段（例如“地点”）。
  • API 参数 metadataFilter 指定该字段中应作为筛选条件的值（例如，此屏幕仅显示“地点”=“拉斯维加斯”的表彰）。

 

配置 API 的步骤：

  1. 在 API 设置中，使用 metadataFilter 请求参数指定筛选值。
  2. 确保该值与您用户数据中存储的元数据值匹配。

 

示例 API 调用：

https://api.awardco.com/api/feed?metadataFilter=Location:London 

 

这确保仅显示带有伦敦地点元数据标签的表彰。如果任何元数据字段被修改或删除，您必须相应更新筛选配置。

 

测试与故障排除

完成设置后，测试动态源以确保所有内容正确显示非常重要。

  • 确认筛选器正确应用，并且基于配置设置显示了正确的表彰内容。
  • 如果遇到任何问题，请检查您的错误邮件通知以获取更多详情。

 

有用资源

为了帮助您完成设置并提供更详细的指导，以下是一些有用的资源：

 

 



 

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

关于