La API de Feed Personalizado te permite filtrar los feeds de reconocimiento de empleados basándote en metadatos, mostrar etiquetas adicionales para los destinatarios y personalizar cómo se muestran los reconocimientos. Aunque la API de Feed Personalizado se usa comúnmente con ScreenCloud, puedes configurarla de forma independiente para satisfacer las necesidades únicas de tu organización. Si deseas integrarte con ScreenCloud, puedes seguir los pasos descritos en este artículo.
Para los clientes que configuran la API de Feed Personalizado directamente, aquí tienes una guía paso a paso para ayudarte a configurarla.
- Acceder a la Configuración de la API
- Configurar el Campo de Filtro (Dentro de la Plataforma)
- Seleccionar Etiquetas de Metadatos (Opcional)
- Habilitar Notificaciones de Errores
- Configurar la API (Filtro de Metadatos)
- Probar y Solucionar Problemas
- Recursos Útiles
Acceder a la Configuración de la API
Para comenzar con la API de Feed Personalizado, inicia sesión en tu Portal de Administración de Awardco y accede a la configuración necesaria.
- Inicia sesión en tu Portal de Administración de Awardco.
- Navega a Configuración de Administración.
- Selecciona Configuración de la API.
- Haz clic en la pestaña Configuración de la API.
Esto abrirá la página donde puedes configurar tanto los ajustes dentro de la plataforma como la configuración de la API necesaria para tu Feed Personalizado.
Configurar el Campo de Filtro (Dentro de la Plataforma)
El Campo de Filtro te permite controlar cómo se filtran los reconocimientos basándote en campos de metadatos, como ubicación, departamento o cualquier otra categoría relevante para tu organización. Este filtro asegura que solo se muestren los reconocimientos que coincidan con ciertos criterios. Para configurar el campo de filtro:
- Elige un campo de metadatos que actuará como filtro. Por ejemplo, si tu empresa tiene varias ubicaciones de oficina, podrías usar el campo de metadatos Ubicación.
- Haz clic en “Guardar Cambios”.
Ejemplo:
Para una empresa con oficinas en diferentes ciudades, seleccionar Ubicación como filtro te permite mostrar reconocimientos basados en ubicaciones específicas, como "Londres" o "Nueva York".
Nota: El Campo de Filtro especifica el campo de metadatos (por ejemplo, "Ubicación"), y más adelante definirás los valores por los cuales filtrar en la propia API.
Seleccionar Etiquetas de Metadatos (Opcional)
Puedes mejorar el feed de reconocimientos mostrando metadatos adicionales, como Departamento o Título del Puesto para cada empleado que recibe reconocimiento. Para configurar las etiquetas de metadatos:
- En Sublabel 1 y Sublabel 2, selecciona los campos de metadatos que deseas mostrar. Ejemplos comunes incluyen Departamento y Título del Puesto.
- Por ejemplo, seleccionar Departamento y Título del Puesto podría mostrar detalles como "Ventas" y "Ejecutivo de Cuentas".
Este paso es opcional, pero puede proporcionar contexto adicional para tu feed de reconocimientos.
Habilitar Notificaciones de Errores
Para asegurar que tu configuración funcione sin problemas, recomendamos habilitar los Correos de Error. Esta función te notificará si hay algún problema con el Feed Personalizado, como configuraciones inválidas o metadatos faltantes.
- Busca la opción Enviar Correos de Error en la configuración.
- Habilita esta función para recibir notificaciones de errores.
Puedes deshabilitar temporalmente los correos de error si estás al tanto de problemas conocidos que están siendo atendidos.
Configurar la API (Filtro de Metadatos)
Una vez configurados los ajustes dentro de la plataforma, deberás definir los valores específicos para el filtrado usando el parámetro de solicitud metadataFilter en las llamadas a la API.
- La configuración del Filtro de Metadatos dentro de la plataforma determina qué campo se usa para filtrar (por ejemplo, Ubicación).
- El parámetro de la API metadataFilter especifica qué valor en ese campo debe usarse como criterio de filtrado (por ejemplo, mostrar solo reconocimientos donde "Ubicación" = "Las Vegas" en esta pantalla).
Para configurar la API:
- En la configuración de la API, usa el parámetro de solicitud metadataFilter para especificar los valores para filtrar.
- Asegúrate de que el valor coincida con los valores de metadatos almacenados en los datos de tus usuarios.
Ejemplo de llamada a la API:
https://api.awardco.com/api/feed?metadataFilter=Location:London
Esto asegura que solo se muestren los reconocimientos etiquetados con el metadato de ubicación Londres.
Si algún campo de metadatos se modifica o elimina, debes actualizar la configuración del filtro en consecuencia.
Probar y Solucionar Problemas
Una vez que hayas completado la configuración, es importante probar el feed para asegurarte de que todo se muestre correctamente.
- Verifica que el filtro se aplique correctamente y que se muestren los reconocimientos correctos según la configuración que hayas establecido.
- Si encuentras algún problema, consulta las notificaciones de correo de error para obtener más detalles.
Recursos Útiles
Para ayudarte con la configuración y proporcionar una guía más detallada, aquí tienes algunos recursos útiles:
- Documentación de la API: Documentación completa sobre cómo usar la API de Feed Personalizado, incluyendo parámetros disponibles y ejemplos.
- Recursos de la API de Awardco: Documentación general de la API y soporte adicional.
If you have any questions, please contact Awardco Admin Support.