A API de Feed Personalizado permite filtrar feeds de reconhecimento de funcionários por metadados, adicionar etiquetas para os destinatários e personalizar as exibições de reconhecimento. É frequentemente usada com o ScreenCloud, mas pode ser configurada de forma independente. Para integração com o ScreenCloud, consulte este artigo.
Para clientes configurando diretamente a API de Feed Personalizado, aqui está um guia passo a passo para ajudá-lo a configurá-la.
- Acessar Configurações da API
- Configurar o Campo de Filtro (Na Plataforma)
- Selecionar Etiquetas 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 na sua conta Awardco.
- Selecione o botão “Admin” na parte inferior do menu de navegação à esquerda.
- Selecione “Plataforma”, depois “Integrações” e então “Configurações da API” no menu de navegação à esquerda.
- 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 que você controle 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. Esse 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á os valores para filtrar na própria API posteriormente.
Selecionar Etiquetas de Metadados (Opcional)
Você pode melhorar o feed de reconhecimento exibindo metadados adicionais, como Departamento ou Cargo para cada funcionário que recebe reconhecimento. Para configurar etiquetas de metadados:
- Em Subtítulo 1 e Subtítulo 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. Esse recurso notificará você se houver quaisquer problemas 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, você precisará 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 do usuário.
Exemplo de chamada de API:
https://api.awardco.com/api/feed?metadataFilter=Location:London
Isso garante que apenas os 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 exibindo corretamente.
- Verifique se o filtro está aplicado corretamente e se os reconhecimentos certos estão sendo exibidos com base nas configurações configuradas.
- Se encontrar algum problema, verifique suas notificações de Email de Erro para mais detalhes.
Recursos Úteis
Para auxiliar na configuração e fornecer orientações mais detalhadas, aqui estão alguns recursos úteis:
- Documentação da API: Guia completo sobre o uso da API de Feed Personalizado, com parâmetros e exemplos.
- Recursos da API Awardco: Documentação da API e suporte.
If you have any questions, please contact Awardco Admin Support.