A API de Feed Personalizado permite filtrar feeds de reconhecimento de funcionários com base em metadados, exibir rótulos adicionais para os destinatários e personalizar como os reconhecimentos são exibidos. Embora a API de Feed Personalizado seja comumente usada com o ScreenCloud, você pode configurá-la de forma independente para atender às necessidades exclusivas da sua organização. Se desejar integrar com o ScreenCloud, você pode seguir os passos descritos em este artigo.
Para clientes que configuram a API de Feed Personalizado diretamente, aqui está um guia passo a passo para ajudar na configuração.
- Acessar Configurações da API
- Configurar o Campo de Filtro (Na Plataforma)
- Selecionar Rótulos de Metadados (Opcional)
- Ativar Notificações de Erro
- Configurar a API (Filtro de Metadados)
- Testar e Solucionar Problemas
- Recursos Úteis
Acessar Configurações da API
Para começar com a API de Feed Personalizado, faça login no seu Portal de Administração Awardco e acesse as configurações de configuração necessárias.
- Faça login no seu Portal de Administração Awardco.
- Navegue até Configurações do Administrador.
- Selecione Configurações da API.
- Clique na aba Configuração da API.
Isso abrirá a página onde você pode configurar tanto as configurações na plataforma quanto a configuração da API necessária para seu Feed Personalizado.
Configurar o Campo de Filtro (Na Plataforma)
O Campo de Filtro permite controlar como os reconhecimentos são filtrados com base em campos de metadados, como localização, departamento ou qualquer outra categoria relevante para sua organização. Este filtro garante que apenas os reconhecimentos que correspondam a certos critérios sejam exibidos. Para configurar o campo de filtro:
- Escolha um campo de metadados que atuará como filtro. Por exemplo, se sua empresa possui vários escritórios, você pode usar o campo de metadados Localização.
- Clique em “Salvar Alterações”.
Exemplo:
Para uma empresa com escritórios em diferentes cidades, selecionar Localização como filtro permite exibir reconhecimentos baseados em locais específicos, como "Londres" ou "Nova York".
Nota: O Campo de Filtro especifica o campo de metadados (por exemplo, "Localização"), e você definirá posteriormente os valores para filtrar na própria API.
Selecionar Rótulos de Metadados (Opcional)
Você pode aprimorar o feed de reconhecimento exibindo metadados adicionais, como Departamento ou Cargo para cada funcionário que recebe reconhecimento. Para configurar os rótulos de metadados:
- Em Sublabel 1 e Sublabel 2, selecione os campos de metadados que deseja exibir. Exemplos comuns incluem Departamento e Cargo.
- Por exemplo, selecionar Departamento e Cargo pode exibir detalhes como "Vendas" e "Executivo de Contas".
Esta etapa é opcional, mas pode fornecer contexto adicional para seu feed de reconhecimento.
Ativar Notificações de Erro
Para garantir que sua configuração funcione sem problemas, recomendamos ativar os Emails de Erro. Este recurso notificará você caso haja algum problema com o Feed Personalizado, como configurações inválidas ou metadados ausentes.
- Encontre a opção Enviar Emails de Erro nas configurações.
- Ative este recurso para receber notificações de erro.
Você pode desativar temporariamente os emails de erro se estiver ciente de problemas conhecidos que estão sendo resolvidos.
Configurar a API (Filtro de Metadados)
Depois que as configurações na plataforma estiverem configuradas, será necessário definir os valores específicos para filtragem usando o parâmetro de requisição metadataFilter nas chamadas da API.
- A configuração do Filtro de Metadados na plataforma determina qual campo será usado para filtragem (por exemplo, Localização).
- O parâmetro da API metadataFilter especifica qual valor naquele campo deve ser usado como critério de filtragem (por exemplo, mostrar apenas reconhecimentos onde "Localização" = "Las Vegas" nesta tela).
Para configurar a API:
- Na configuração da API, use o parâmetro de requisição metadataFilter para especificar valores para filtragem.
- Certifique-se de que o valor corresponda aos valores de metadados armazenados nos dados dos usuários.
Exemplo de chamada API:
https://api.awardco.com/api/feed?metadataFilter=Location:London
Isso garante que apenas reconhecimentos marcados com o metadado de localização Londres sejam exibidos.
Se algum campo de metadados for modificado ou removido, você deve atualizar a configuração do filtro de acordo.
Testar e Solucionar Problemas
Depois de concluir a configuração, é importante testar o feed para garantir que tudo esteja sendo exibido corretamente.
- Verifique se o filtro está aplicado corretamente e se os reconhecimentos certos estão sendo mostrados com base nas configurações configuradas.
- Se encontrar algum problema, verifique suas notificações de Email de Erro para mais detalhes.
Recursos Úteis
Para ajudar na configuração e fornecer orientações mais detalhadas, aqui estão alguns recursos úteis:
- Documentação da API: Documentação completa sobre como usar a API de Feed Personalizado, incluindo parâmetros disponíveis e exemplos.
- Recursos da API Awardco: Documentação geral da API e suporte adicional.
If you have any questions, please contact Awardco Admin Support.