如何设置自定义 Feed API（传统版）

自定义 Feed API 允许您根据元数据筛选员工认可动态，为接收者显示额外标签，并自定义认可的显示方式。虽然自定义 Feed API 通常与 ScreenCloud 一起使用，但您也可以独立设置以满足您组织的独特需求。如果您希望与 ScreenCloud 集成，可以按照本文中列出的步骤操作。

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

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

访问 API 设置

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

1. 登录您的 Awardco 管理门户。
2. 导航到管理设置。
3. 选择 API 设置。
4. 点击 API 配置标签。

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

配置过滤字段（平台内）

过滤字段允许您根据元数据字段（例如地点、部门或其他与您组织相关的类别）控制认可的筛选方式。此过滤器确保只显示符合特定条件的认可。配置过滤字段的步骤如下：

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

示例：

对于在不同城市设有办公室的公司，选择“地点”作为过滤器可以根据特定地点显示认可，如“伦敦”或“纽约”。

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

选择元数据标签（可选）

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

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

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

启用错误通知

为确保您的设置顺利运行，建议启用错误邮件功能。此功能将在自定义 Feed 出现问题时通知您，例如配置无效或元数据缺失。

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

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

配置 API（元数据过滤器）

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

• 平台内的元数据过滤器设置决定使用哪个字段进行筛选（例如地点）。
• API 参数 metadataFilter 指定该字段中应使用哪个值作为筛选条件（例如，此屏幕只显示“地点”=“拉斯维加斯”的认可）。

配置 API 的步骤：

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

示例 API 调用：

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

这确保只显示带有“伦敦”地点元数据标签的认可。

如果任何元数据字段被修改或移除，您必须相应更新过滤配置。

测试和故障排除

完成设置后，测试 Feed 以确保一切显示正常非常重要。

• 验证过滤器是否正确应用，并且根据您的配置显示了正确的认可。
• 如果遇到任何问题，请检查您的错误邮件通知以获取更多详情。

有用资源

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

• API 文档：关于如何使用自定义 Feed API 的完整文档，包括可用参数和示例。
• Awardco API 资源：通用 API 文档及额外支持。

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