Compartilhar via


Base de funcionários (versão prévia)

Com o Conector do Staffbase, você faz a ponte entre ferramentas e sistemas diferentes e integra a plataforma Staffbase aos seus fluxos de trabalho automatizados. Isso inclui seu aplicativo funcionário ou intranet para automatizar processos, executar tarefas em um agendamento ou notificar os usuários quando ocorrerem eventos.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte do Staffbase
URL https://www.staffbase.com
Email support@staffbase.com
Metadados do conector
Publicador Staffbase GmbH
Site da Web https://www.staffbase.com
Política de privacidade https://staffbase.com/en/privacy-policy/
Categorias Comunicação; Recursos humanos

Conector do Staffbase

Com o conector do Staffbase para Power Automate, você faz a ponte entre diferentes ferramentas e sistemas e inclui a plataforma Staffbase em seus fluxos de trabalho automatizados. Aproveite o poder dos fluxos de trabalho automatizados que incluem seu aplicativo funcionário ou intranet para automatizar processos, executar tarefas em um agendamento ou notificar os usuários à medida que os eventos ocorrem.

Pré-requisitos

  • Um plano do Microsoft Power Apps ou do Power Automate com o recurso de conector personalizado
  • Uma licença do Staffbase para sua organização
  • A função de administrador da sua organização na plataforma Staffbase
  • O token de API para configurar a autenticação
  • Informações sobre em qual infraestrutura staffasbe seu aplicativo está hospedado, entre em contato para support@staffbase.com obter mais informações

Operações com suporte

ChannelsGetList

Obter uma lista de canais de notícias

ChannelsGetPosts

Obter uma lista de postagens no canal especificado

ChannelsPostPost

Enviar uma postagem para um canal específico

CommentsGet

Obter todos os comentários de sua instância do Staffbase

MediaGet

Obter toda a mídia de sua instância do Staffbase

MediaGetByID

Obter mídia por ID

MediaDelete

Excluir mídia por ID

NotificationPost

Envia notificação para usuários

PostsGetAll

Obter uma lista de postagens

PostsGetByID

Obter uma postagem por ID

PostsDelete

Remove uma postagem

PostPut

Atualiza uma postagem

UserGetAll

Obter lista de usuários

UserPost

Convidar um usuário por nome, sobrenome e eMail

UserGetByID

Obter informações do usuário

User_delete

Excluir Usuário por ID

UserPut

Atualizar informações do usuário

UserPostRecovery

Enviar um email de recuperação

ProxyVersionGet

Apenas para uso interno, para verificar a versão atual do proxy de API

Obtendo credenciais

Para a autenticação básica entre sua plataforma Staffbase e o fluxo de trabalho criado no Power Automate, você precisa de um token de API. Você pode gerar o token de API do Staffbase Experience Studio.

Introdução

Configure o conector com a autenticação básica e a URL de hospedagem.

  1. No Power Automate, navegue até Conectores.
  2. Pesquise o conector do Staffbase.
  3. Clique no conector do Staffbase. Uma caixa de diálogo para configurar o conector é aberta.
  4. No campo Token de API, adicione o token de API usando a seguinte sintaxe: Básico [API-Token]

Observação: você precisa adicionar um espaço vazio entre 'Basic' e o token de API.

No campo ID do Host, insira o identificador para a infraestrutura em que a plataforma Staffbase está hospedada:

  • Infraestrutura alemã: de1
  • Infraestrutura internacional: us1

Para obter informações detalhadas, visite o Portal de Suporte do Staffbase.

Problemas e limitações conhecidos

Atualmente, o conector do Staffbase não dá suporte a todos os recursos da API do Staffbase. Para obter informações mais detalhadas sobre APIs do Staffbase, visite o Portal do Desenvolvedor do Staffbase.

Perguntas frequentes

Quais fluxos de trabalho de negócios podem ser automatizados usando o conector do Staffbase?

Muitos processos de negócios podem ser automatizados usando o conector staffbase. Por exemplo, notifique seus funcionários diretamente em seu aplicativo funcionário ou intranet como e quando as ações ocorrem em outras ferramentas. Saiba mais sobre esses casos de uso de negócios aqui.

Há tutoriais para me ajudar a começar a usar um fluxo de trabalho automatizado usando o conector do Staffbase?

O Staffbase oferece tutoriais que usam nosso plug-in do Forms e o conector do Staffbase para automatizar o gerenciamento de instalações. Saiba tudo sobre como configurá-lo nesta seção.

Instruções de implantação

Execute os seguintes comandos e siga os prompts:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
API-Key secureString "Chave de API" para a instância do Staffbase Verdade
ID de hospedagem cadeia Especifique sua ID de hospedagem: hostingID Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Canais: enviar uma postagem para um canal específico

Envie uma postagem para um canal de notícias específico.

Canais: Obter uma lista de canais de notícias

Obtenha uma lista de canais de notícias.

Canais: obter uma lista de postagens no canal especificado

Obtenha uma lista de postagens no canal especificado.

Mídia: Excluir mídia

Exclui a mídia especificada no contexto atual.

Mídia: Obter mídia por ID

Obtenha metadados para mídia única por sua ID.

Mídia: Obter toda a mídia

Solicita a descrição de todas as mídias disponíveis no contexto atual.

Notificação: Envia notificação

Envia notificações para usuários especificados.

Postagens: Atualiza uma postagem

Atualiza uma postagem, apenas o campo alterado (incremental).

Postagens: Obter comentários

Obtenha uma lista de comentários.

Postagens: Obter uma lista de postagens

Obtenha uma lista de postagens acessíveis para o token de API.

Postagens: Obter uma postagem por ID

Solicita as postagens especificadas, incluindo um conjunto de comentários.

Postagens: Remove uma postagem

Remove uma postagem do sistema.

Proxy: Obter versão

Retorna a versão do proxy atual.

Usuário: Atualizar informações do usuário

Atualize as informações do usuário.

Usuário: Convidar usuário

O usuário receberá um email para se inscrever.

Usuário: Enviar um email de recuperação

Envia um email de recuperação para o usuário especificado.

Usuário: Excluir Usuário

Exclui o usuário especificado.

Usuário: Obter informações do usuário

Obtenha informações específicas do usuário por sua ID de usuário.

Usuário: Obter lista de usuários

Obtenha uma lista de usuários, dependendo do token de acesso à API.

Canais: enviar uma postagem para um canal específico

Envie uma postagem para um canal de notícias específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ChannelID
channelID True string

Insira a ID do canal aqui.

ID externo
externalID string

Opcional: insira uma ID externa aqui.

localidade
locale string

Inserir localidade como, por exemplo, de_DE, en_US etc.

conteúdo
content string

Insira o conteúdo de notícias aqui.

image (link)
image string

Insira o link da imagem aqui.

teaser
teaser string

Insira seu teaser aqui.

title
title string

Insira seu título aqui.

publicado
published string

Insira sua data publicada aqui.

Canais: Obter uma lista de canais de notícias

Obtenha uma lista de canais de notícias.

Retornos

Nome Caminho Tipo Description
total
total integer

Número total de canais encontrados.

limit
limit integer

A quantidade de itens retornados.

deslocamento
offset integer

O deslocamento definido atual para obter os itens a partir desse número.

dados
data array of object
id
data.id string

Esta é a ID do canal.

localização
data.config.localization array of object
title
data.config.localization.title string

O título do canal localizado.

localidade
data.config.localization.locale string

Esta é a localidade do título do canal.

spaceID
data.spaceID string

A ID do espaço ao qual o canal é atribuído.

criadas
data.created string

A data criada do canal.

publicado
data.published string

A data publicada do canal.

atualizado
data.updated string

A data atualizada do canal.

Canais: obter uma lista de postagens no canal especificado

Obtenha uma lista de postagens no canal especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ChannelID
channelID True string

Insira a ID do canal aqui, por exemplo, recuperada por getChannels.

Limit
limit integer

A quantidade de itens que devem ser retornados (padrão e máximo de 100).

Offset
offset integer

Defina um deslocamento para obter os itens começando neste número.

Retornos

Nome Caminho Tipo Description
total
total integer

Número total de postagens encontradas.

limit
limit integer

A quantidade de itens retornados.

deslocamento
offset integer

O deslocamento definido atual para obter os itens a partir desse número.

dados
data array of postData

Mídia: Excluir mídia

Exclui a mídia especificada no contexto atual.

Parâmetros

Nome Chave Obrigatório Tipo Description
MediumID
mediumID True string

Exclui o meio por sua ID. Embora isso remova imediatamente o recurso de nossos servidores, a CDN ainda pode fornecer o conteúdo por meio da URL declarada em resourceInfo.url até a invalidação da CDN.

Mídia: Obter mídia por ID

Obtenha metadados para mídia única por sua ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
MediumID
mediumID True string

Solicita informações sobre um meio específico.

Retornos

Corpo
mediaData

Mídia: Obter toda a mídia

Solicita a descrição de todas as mídias disponíveis no contexto atual.

Parâmetros

Nome Chave Obrigatório Tipo Description
Limit
limit integer

Limite o número de itens aqui.

Offset
offset integer

Defina um deslocamento para a consulta.

Retornos

Nome Caminho Tipo Description
total
total integer

Número total de ativos encontrados.

limit
limit integer

A quantidade de itens retornados.

deslocamento
offset integer

O deslocamento definido atual para obter os itens a partir desse número.

dados
data array of mediaData

Notificação: Envia notificação

Envia notificações para usuários especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
accessorIds
accessorIds array of string
localidade
locale string

Inserir localidade como, por exemplo, de_DE, en_US etc.

title
title string

Inserir título dependente de idioma.

link
link string

Optinal: insira o link aqui.

Retornos

Nome Caminho Tipo Description
id
id string

Essa é a ID da notificação.

accessorIds
recipients.accessorIds array of string

Esta é a lista de IDs de destinatários.

conteúdo
content array of object
title
content.title string

O título da notificação localizada.

localidade
content.locale string

Esta é a localidade do título.

link
link string

Este é o link de notificação.

tipo
type string

Esse é o tipo de notificação.

createdAt
createdAt string

A data criada da notificação.

criadas
created string

A data criada da notificação.

Postagens: Atualiza uma postagem

Atualiza uma postagem, apenas o campo alterado (incremental).

Parâmetros

Nome Chave Obrigatório Tipo Description
PageID
pageID True string

Essa pode ser a ID de postagem definida pela API ou se definir a externalID pós-external.

ID externo
externalID string

Opcional: insira uma ID externa aqui.

localidade
locale string

Inserir localidade como, por exemplo, de_DE, en_US etc.

conteúdo
content string

Insira o conteúdo de notícias aqui.

imagem
image string

Insira o link para a imagem aqui.

teaser
teaser string

Insira seu teaser aqui.

title
title string

Insira seu título aqui.

publicado
published string

Insira sua data publicada aqui.

Postagens: Obter comentários

Obtenha uma lista de comentários.

Parâmetros

Nome Chave Obrigatório Tipo Description
Manage
manage boolean

Quando true e a função de token permitem gerenciar comentários , também não serão mostrados comentários publicados na lista.

Limit
limit integer

A quantidade de itens que devem ser retornados (padrão e máximo de 100).

Offset
offset integer

Defina um deslocamento para obter os itens começando neste número.

Filter
filter string

Filtre no formato SCIM2 com suporte parcial. Por enquanto, há suporte apenas para estrutura simples (sem cláusulas aninhadas) e cláusulas de comparação como eq = "equals", gt = "maior que", ge = "maior ou igual a", lt = "menor que", le = "menor ou igual" . Para comentários, os campos de filtro com suporte são: criados e atualizados. O valor desses campos pode ser fornecido na representação da cadeia de caracteres UTC DateTime ou no número longo de milissegundos da época unix. Exemplo 1: filter=updated ge "2020-11-26T10:14:48.947Z" e atualizado le "2020-11-26T10:14:48.947Z". Neste exemplo, o filtro de intervalo DateTime é aplicado ao campo atualizado com cláusulas de comparação ge e le e cláusula booliana. Exemplo 2: filter=created gt "2020-11-26T10:14:48.947Z". Obtenha todos os comentários, criados após a data apontada.

Retornos

Nome Caminho Tipo Description
total
total integer

Número total de comentários encontrados.

limit
limit integer

A quantidade de itens retornados.

deslocamento
offset integer

O deslocamento definido atual para obter os itens a partir desse número.

dados
data array of object
id
data.id string

Esta é a ID do comentário.

parentID
data.parentID string

A ID do pai do comentário pode ser uma postagem ou um comentário.

tipo de pai
data.parentType string

O tipo pai pode ser uma postagem ou um comentário.

texto de comentário
data.text string

Esse é o conteúdo de comentários/teste em si.

ID de postagem
data.rootID string

Esta é a ID da postagem à qual este comentário está relacionado

autor
data.author authorObject
total
data.likes.total integer

Esse é o número de curtidas de comentário.

isLiked
data.likes.isLiked string

Este comentário foi curtido?

criadas
data.created string

A data criada do comentário.

atualizado
data.updated string

A data atualizada do comentário.

imagem
data.image imageObject

Postagens: Obter uma lista de postagens

Obtenha uma lista de postagens acessíveis para o token de API.

Parâmetros

Nome Chave Obrigatório Tipo Description
Query
query string

Uma cadeia de caracteres que pode ser usada para pesquisar o conteúdo da postagem.

Limit
limit integer

A quantidade de itens que devem ser retornados (padrão e máximo de 100).

Offset
offset integer

Defina um deslocamento para obter os itens começando neste número.

Manejável
manageable boolean

Filtro opcional para os tipos de conteúdo de postagem especificados. O padrão é não filtrar.

ContentType
contentType string

Filtro opcional para os tipos de conteúdo de postagem especificados. (O padrão é não filtrar)

Retornos

Nome Caminho Tipo Description
total
total integer

Número total de postagens encontradas.

limit
limit integer

A quantidade de itens retornados.

deslocamento
offset integer

O deslocamento definido atual para obter os itens a partir desse número.

dados
data array of postData

Postagens: Obter uma postagem por ID

Solicita as postagens especificadas, incluindo um conjunto de comentários.

Parâmetros

Nome Chave Obrigatório Tipo Description
PageID
pageID True string

Esta é a ID da postagem.

Retornos

Corpo
postData

Postagens: Remove uma postagem

Remove uma postagem do sistema.

Parâmetros

Nome Chave Obrigatório Tipo Description
PageID
pageID True string

Essa pode ser a ID de postagem definida pela API ou se definir a externalID pós-external.

Retornos

Nome Caminho Tipo Description
identificador
identifier integer

O identificador da exclusão.

código de status
statusCode integer

O código de status da ação.

mensagem
message string

A mensagem da ação.

tipo
type string

O tipo da ação.

Proxy: Obter versão

Retorna a versão do proxy atual.

Usuário: Atualizar informações do usuário

Atualize as informações do usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
UserID
userID True string

A ID pode ser baseada na UserID gerada automaticamente pela plataforma Staffbase ou pela externalID, se ela for adicionada ao usuário.

id
id string

A ID do usuário

ID externo
externalID string

A ID externa do usuário

primeiro nome
firstName string

O nome do usuário

sobrenome
lastName string

O sobrenome do usuário

publicEmailAddress
publicEmailAddress string

O eMail público do usuário

localidade
locale string

A localidade do usuário

email
value string

O endereço de email

primário
primary boolean

É o email principal?

groupIDs
groupIDs array of string
position
position string

A posição do usuário

departamento
department string

O departamento do usuário

local
location string

O local do usuário

número de telefone
phoneNumber string

O número de telefone do usuário

criadas
created string

A data criada do usuário

atualizado
updated string

A data atualizada do usuário

ativado
activated string

O usuário está ativado?

Retornos

Corpo
userData

Usuário: Convidar usuário

O usuário receberá um email para se inscrever.

Parâmetros

Nome Chave Obrigatório Tipo Description
email
email string

Esse é o endereço de email do usuário.

primeiro nome
firstName string

Este é o primeiro nome do usuário.

sobrenome
lastName string

Este é o último nome do usuário.

Usuário: Enviar um email de recuperação

Envia um email de recuperação para o usuário especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
UserID
userID True string

A ID pode ser baseada na UserID gerada automaticamente pela plataforma Staffbase ou pela externalID, se ela for adicionada ao usuário.

Usuário: Excluir Usuário

Exclui o usuário especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
UserID
userID True string

A ID pode ser baseada na UserID gerada automaticamente pela plataforma Staffbase ou pela externalID, se ela for adicionada ao usuário.

Usuário: Obter informações do usuário

Obtenha informações específicas do usuário por sua ID de usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
UserID
userID True string

A ID pode ser baseada na UserID gerada automaticamente pela plataforma Staffbase ou pela externalID, se ela for adicionada ao usuário.

Retornos

Corpo
userData

Usuário: Obter lista de usuários

Obtenha uma lista de usuários, dependendo do token de acesso à API.

Parâmetros

Nome Chave Obrigatório Tipo Description
A notação SCIM pode ser usada para filtrar
filter string

A notação SCIM pode ser usada para filtrar.

A pesquisa de texto completo pode ser combinada com o filtro
query string

Aqui você pode fazer serach em qualquer campo de perfil.

Definições

mediaData

Nome Caminho Tipo Description
id
id string

Essa é a ID do ativo.

ownerID
ownerID string

Essa é a ID do proprietário desse ativo.

parentID
parentID string

Essa é a ID do ativo de mídia pai.

publicID
publicID string

Essa é a ID pública para acessar o ativo.

tipo
resourceInfo.type string

Esse é o tipo de recurso de ativo.

Bytes
resourceInfo.bytes integer

Esse é o tamanho do recurso (em bytes).

largura
resourceInfo.width integer

Essa é a largura do recurso.

height
resourceInfo.height integer

Essa é a altura do recurso.

url
resourceInfo.url string

Essa é a URL do recurso.

format
resourceInfo.format string

Esse é o formato de recurso.

Tipo MIME
resourceInfo.mimeType string

Esse é o tipo MIME do recurso.

fileName
fileName string

Esse é o nome do arquivo de mídia.

title
title string

Este é o título da mídia.

etiqueta
label string

Esse é o rótulo de mídia.

criadas
created string

A data criada do ativo.

dados do usuário

Nome Caminho Tipo Description
id
id string

A ID do usuário

ID externo
externalID string

A ID externa do usuário

primeiro nome
firstName string

O nome do usuário

sobrenome
lastName string

O sobrenome do usuário

publicEmailAddress
publicEmailAddress string

O eMail público do usuário

localidade
config.locale string

A localidade do usuário

e-mails
emails array of object

Informações de email do usuário

email
emails.value string

O endereço de email

primário
emails.primary boolean

É o email principal?

groupIDs
groupIDs array of string
position
position string

A posição do usuário

departamento
department string

O departamento do usuário

local
location string

O local do usuário

número de telefone
phoneNumber string

O número de telefone do usuário

criadas
created string

A data criada do usuário

atualizado
updated string

A data atualizada do usuário

ativado
activated string

O usuário está ativado?

postData

Nome Caminho Tipo Description
id
id string

A ID da postagem.

autor
author authorObject
contents
contents array of object
conteúdo
contents.content string

O conteúdo da postagem, que é localizado.

imagem
contents.image imageObject
teaser
contents.teaser string

O teaser de postagem, que é localizado.

title
contents.title string

O título do post, que é localizado.

localidade
contents.locale string

Essa é a localidade do item.

id
channel.id string

Esta é a ID do canal.

localização
channel.config.localization array of object
title
channel.config.localization.title string

Esse é o título do canal, que é localizado.

localidade
channel.config.localization.locale string

Esta é a localidade do título do canal.

publicado
published string

A data publicada da postagem.

criadas
created string

A data criada da postagem.

atualizado
updated string

A data atualizada da postagem.

authorObject

Nome Caminho Tipo Description
primeiro nome
firstName string

Este é o nome do autor.

id
id string

Esta é a ID do autor.

sobrenome
lastName string

Este é o sobrenome do autor.

url
avatar.original.url string

Esta é a URL original da imagem do avatar do autor.

largura
avatar.original.width integer

Esta é a largura original da imagem de avatar do autor.

height
avatar.original.height integer

Esta é a altura original da imagem do avatar do autor.

size
avatar.original.size integer

Este é o sie original da imagem de avatar do autor (em bytes).

format
avatar.original.format string

Este é o formato original do avatar do autor.

Tipo MIME
avatar.original.mimeType string

Este é o mimeType original da imagem de avatar do athor.

criadas
avatar.original.created string

Esta é a data de criação original do avatar do autor.

url
avatar.icon.url string

Esta é a URL do ícone de avatar do autor.

largura
avatar.icon.width integer

Essa é a largura do ícone de avatar do autor.

height
avatar.icon.height integer

Esta é a altura do ícone de avatar do autor.

format
avatar.icon.format string

Este é o formato de ícone de avatar do autor.

Tipo MIME
avatar.icon.mimeType string

Este é o ícone de avatar do autor mimeType.

url
avatar.thumb.url string

Esta é a URL do avatar do autor.

largura
avatar.thumb.width integer

Esta é a largura do polegar do avatar do autor.

height
avatar.thumb.height integer

Esta é a altura do polegar do avatar do autor.

format
avatar.thumb.format string

Este é o formato de miniatura do avatar do autor.

Tipo MIME
avatar.thumb.mimeType string

Este é o mimeType do avatar do athor.

publicID
avatar.publicID string

Esta é a ID pública do avatar do autor.

imageObject

Nome Caminho Tipo Description
url
original.url string

Esta é a URL original da imagem.

largura
original.width integer

Essa é a largura original da imagem.

height
original.height integer

Esta é a altura original da imagem.

size
original.size integer

Esse é o tamanho original da imagem (em bytes).

format
original.format string

Esse é o formato original da imagem.

Tipo MIME
original.mimeType string

Este é o mimeType original da imagem.

url
original_scaled.url string

Esta é a URL original da imagem.

largura
original_scaled.width integer

Essa é a largura original da imagem.

height
original_scaled.height integer

Esta é a altura original da imagem.

format
original_scaled.format string

Esse é o formato original da imagem.

Tipo MIME
original_scaled.mimeType string

Este é o mimeType original da imagem.

url
compact.url string

Esta é a URL compacta de imagem.

largura
compact.width integer

Essa é a largura compacta da imagem.

height
compact.height integer

Essa é a altura compacta da imagem.

format
compact.format string

Esse é o formato compacto da imagem.

Tipo MIME
compact.mimeType string

Este é o mimeType compacto de imagem.