Partilhar via


Staffbase (Pré-visualização)

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

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Staffbase
URL https://www.staffbase.com
Email support@staffbase.com
Metadados do conector
Editora Staffbase GmbH
Sítio Web https://www.staffbase.com
Política de privacidade https://staffbase.com/en/privacy-policy/
Categorias Comunicação; Recursos Humanos

Conector Staffbase

Com o conector Staffbase para Power Automatic, você preenche a lacuna 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 de funcionário ou intranet para automatizar processos, executar tarefas em uma agenda ou notificar os usuários à medida que os eventos ocorrem.

Pré-requisitos

  • Um plano Microsoft Power Apps ou Power Automate com recurso de conector personalizado
  • Uma licença Staffbase para a sua organização
  • A função de administrador da sua organização na plataforma Staffbase
  • O token da 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 suportadas

CanaisGetList

Obter uma lista de canais de notícias

CanaisGetPosts

Obter uma lista de publicações dentro do canal especificado

CanaisPostPost

Enviar uma publicação para um canal específico

ComentáriosObter

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

MediaGet

Obtenha todas as mídias da sua instância do Staffbase

MediaGetByID

Obter multimédia por ID

MediaDelete

Excluir mídia por ID

NotificaçãoPost

Envia notificação ao(s) utilizador(es)

PostsGetAll

Obter uma lista de publicações

PostsGetByID

Obter uma publicação por ID

PostsDelete

Remove uma publicação

PostsPut

Atualiza uma publicação

UserGetAll

Obter lista de usuários

UserPost

Convidar um usuário por nome, sobrenome e e-mail

UserGetByID

Obter informações do usuário

User_delete

Excluir usuário por ID

UserPut

Atualizar informações do usuário

UserPostRecovery

Enviar um e-mail de recuperação

ProxyVersionObter

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

Obtenção de 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 autenticação básica e a URL de hospedagem.

  1. Em Power Automate, navegue até Conectores.
  2. Procure o conector Staffbase.
  3. Clique no conector 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: Basic [API-Token]

Nota: Você precisa adicionar um espaço vazio entre 'Basic' e o token da API.

No campo Host ID, insira o identificador da infraestrutura onde sua plataforma Staffbase está hospedada:

  • Infraestrutura alemã: de1
  • Infraestrutura internacional: us1

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

Problemas conhecidos e limitações

O conector Staffbase atualmente não suporta todos os recursos da API do Staffbase. Para obter informações mais detalhadas sobre as 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 Staffbase?

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

Existem tutoriais para me ajudar a começar com um fluxo de trabalho automatizado usando o conector Staffbase?

O Staffbase oferece tutoriais que usam nosso plug-in Forms e o conector Staffbase para automatizar o gerenciamento de suas 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>

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 "API-Key" para a instância Staffbase Verdade
ID de hospedagem cadeia (de caracteres) Especifique seu ID de hospedagem: hostingID Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Canais: Envie uma publicação para um canal específico

Envie uma publicação para um canal de notícias específico.

Canais: Obtenha uma lista de canais de notícias

Obtenha uma lista de canais de notícias.

Canais: obtenha uma lista de publicações dentro do canal especificado

Obtenha uma lista de publicações dentro do canal especificado.

Mídia: Excluir mídia

Exclui a mídia especificada no contexto atual.

Mídia: Obtenha todas as mídias

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

Mídia: Obter mídia por ID

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

Notificação: Envia notificação

Envia notificações para o(s) usuário(s) especificado(s).

Postagens: Atualiza uma publicação

Atualiza uma publicação, apenas campo alterado (incremental).

Postagens: Obter uma lista de posts

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

Postagens: Obter uma publicação por ID

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

Postagens: Remove uma publicação

Remove uma postagem do sistema.

Posts: Receba comentários

Obtenha uma lista de comentários.

Proxy: Obter versão

Retorna a versão de 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 e-mail para se inscrever.

Usuário: Enviar um e-mail de recuperação

Envia um e-mail 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 seu ID de usuário.

Usuário: Obter lista de usuários

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

Canais: Envie uma publicação para um canal específico

Envie uma publicação para um canal de notícias específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do canal
channelID True string

Insira o ID do canal aqui.

ID externo
externalID string

Opcional: insira uma ID externa aqui.

região
locale string

Insira localidades como, por exemplo, de_DE, en_US, etc.

conteúdo
content string

Insira o conteúdo de notícias aqui.

imagem (link)
image string

Insira o link da imagem aqui.

teaser
teaser string

Insira o seu teaser aqui.

title
title string

Introduza o seu título aqui.

publicado em
published string

Introduza a sua data de publicação aqui.

Canais: Obtenha uma lista de canais de notícias

Obtenha uma lista de canais de notícias.

Devoluções

Name Caminho Tipo Description
total
total integer

Número total de canais encontrados.

limit
limit integer

A quantidade de itens que são devolvidos.

offset
offset integer

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

dados
data array of object
id
data.id string

Este é o ID do canal.

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

O título do canal que está localizado.

região
data.config.localization.locale string

Esta é a localidade do título do canal.

ID do espaço
data.spaceID string

O ID do espaço onde o canal é atribuído.

criado
data.created string

A data de criação do canal.

publicado em
data.published string

A data de publicação do canal.

atualizado
data.updated string

A data atualizada do canal.

Canais: obtenha uma lista de publicações dentro do canal especificado

Obtenha uma lista de publicações dentro do canal especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do canal
channelID True string

Insira o ID do canal aqui, por exemplo, recuperado por getChannels.

Limite
limit integer

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

Compensação
offset integer

Defina um deslocamento para obter os itens a partir desse número.

Devoluções

Name Caminho Tipo Description
total
total integer

Número total de posts encontrados.

limit
limit integer

A quantidade de itens que são devolvidos.

offset
offset integer

O deslocamento definido atualmente 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

Name Chave Necessário Tipo Description
MediumID
mediumID True string

Exclui a mídia por seu ID. Embora isso remova imediatamente o recurso de nossos servidores, a CDN ainda pode entregar o conteúdo por meio da URL indicada em resourceInfo.url até a invalidação da CDN.

Mídia: Obtenha todas as mídias

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

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit integer

Limite o número de itens aqui.

Compensação
offset integer

Defina um deslocamento para a consulta.

Devoluções

Name Caminho Tipo Description
total
total integer

Número total de ativos encontrados.

limit
limit integer

A quantidade de itens que são devolvidos.

offset
offset integer

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

dados
data array of mediaData

Mídia: Obter mídia por ID

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

Parâmetros

Name Chave Necessário Tipo Description
MediumID
mediumID True string

Solicita informações num suporte específico.

Devoluções

Body
mediaData

Notificação: Envia notificação

Envia notificações para o(s) usuário(s) especificado(s).

Parâmetros

Name Chave Necessário Tipo Description
accessorIds
accessorIds array of string
região
locale string

Insira localidades como, por exemplo, de_DE, en_US, etc.

title
title string

Inserir título dependente do idioma.

ligação
link string

Optinal: Insira o link aqui.

Devoluções

Name Caminho Tipo Description
id
id string

Este é o 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 que está localizado.

região
content.locale string

Esta é a localidade do título.

ligação
link string

Este é o link de notificação.

tipo
type string

Este é o tipo de notificação.

criadosAt
createdAt string

A data de criação da notificação.

criado
created string

A data de criação da notificação.

Postagens: Atualiza uma publicação

Atualiza uma publicação, apenas campo alterado (incremental).

Parâmetros

Name Chave Necessário Tipo Description
PageID
pageID True string

Isso pode ser o ID de postagem definido pela API ou se definido o ID externo de postagem.

ID externo
externalID string

Opcional: insira uma ID externa aqui.

região
locale string

Insira localidades 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 o seu teaser aqui.

title
title string

Introduza o seu título aqui.

publicado em
published string

Introduza a sua data de publicação aqui.

Postagens: Obter uma lista de posts

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

Parâmetros

Name Chave Necessário Tipo Description
Query
query string

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

Limite
limit integer

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

Compensação
offset integer

Defina um deslocamento para obter os itens a partir desse número.

Gerenciável
manageable boolean

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

Tipo de conteúdo
contentType string

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

Devoluções

Name Caminho Tipo Description
total
total integer

Número total de posts encontrados.

limit
limit integer

A quantidade de itens que são devolvidos.

offset
offset integer

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

dados
data array of postData

Postagens: Obter uma publicação por ID

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

Parâmetros

Name Chave Necessário Tipo Description
PageID
pageID True string

Este é o ID da postagem.

Devoluções

Body
postData

Postagens: Remove uma publicação

Remove uma postagem do sistema.

Parâmetros

Name Chave Necessário Tipo Description
PageID
pageID True string

Isso pode ser o ID de postagem definido pela API ou se definido o ID externo de postagem.

Devoluções

Name Caminho Tipo Description
identificador
identifier integer

O identificador de exclusão.

código de estado
statusCode integer

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

mensagem
message string

A mensagem da ação.

tipo
type string

O tipo de ação.

Posts: Receba comentários

Obtenha uma lista de comentários.

Parâmetros

Name Chave Necessário Tipo Description
Manage
manage boolean

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

Limite
limit integer

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

Compensação
offset integer

Defina um deslocamento para obter os itens a partir desse número.

Filter
filter string

Filtro no formato SCIM2 com suporte parcial. Por enquanto, apenas a estrutura plana (sem cláusulas aninhadas) e cláusulas de comparação como eq = "igual", gt = "maior que", ge = "maior que ou igual", lt = "menor que", le = "menor que ou igual" são suportadas. Para comentários, os campos de filtro suportados são: criados e atualizados. O valor para estes campos pode ser fornecido na representação da string UTC DateTime ou no número longo de milissegundos da época Unix. Exemplo 1: filter=updated ge "2020-11-26T10:14:48.947Z" e updated 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 booleana. Exemplo 2: filter=created gt "2020-11-26T10:14:48.947Z". Obter todos os comentários, criados após a data apontada.

Devoluções

Name Caminho Tipo Description
total
total integer

Número total de comentários encontrados.

limit
limit integer

A quantidade de itens que são devolvidos.

offset
offset integer

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

dados
data array of object
id
data.id string

Este é o ID do comentário.

identificação dos pais
data.parentID string

O ID do pai do comentário pode ser uma publicação ou um comentário.

tipo pai
data.parentType string

O tipo pai pode ser uma publicação ou um comentário.

Texto do comentário
data.text string

Este é o conteúdo dos comentários / teste em si.

ID do post
data.rootID string

Este é o ID do post com o qual este comentário está relacionado

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

Este é o número de curtidas de comentários.

isGostou
data.likes.isLiked string

Este comentário foi apreciado?

criado
data.created string

A data de criação do comentário.

atualizado
data.updated string

A data atualizada do comentário.

imagem
data.image imageObject

Proxy: Obter versão

Retorna a versão de proxy atual.

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

Atualize as informações do usuário.

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
userID True string

O ID pode ser baseado no UserID gerado automaticamente pela plataforma Staffbase ou no externalID, se for adicionado para o usuário.

id
id string

O ID do usuário

ID externo
externalID string

O ID externo do usuário

primeiroNome
firstName string

O nome próprio do utilizador

sobrenome
lastName string

O sobrenome do usuário

publicEmailAddress
publicEmailAddress string

O e-mail público do usuário

região
locale string

A localidade do usuário

e-mail
value string

O endereço de e-mail

primário
primary boolean

É o e-mail principal?

IDs de grupo
groupIDs array of string
posição
position string

A posição do utilizador

departamento
department string

O departamento do utilizador

localização
location string

A localização do utilizador

Número de telefone
phoneNumber string

O número de telefone do utilizador

criado
created string

A data de criação do usuário

atualizado
updated string

A data de atualização do usuário

ativado
activated string

O usuário está ativado?

Devoluções

Body
userData

Usuário: Convidar usuário

O usuário receberá um e-mail para se inscrever.

Parâmetros

Name Chave Necessário Tipo Description
e-mail
email string

Este é o endereço de e-mail do usuário.

primeiroNome
firstName string

Este é o primeiro nome do usuário.

sobrenome
lastName string

Este é o sobrenome do usuário.

Usuário: Enviar um e-mail de recuperação

Envia um e-mail de recuperação para o usuário especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
userID True string

O ID pode ser baseado no UserID gerado automaticamente pela plataforma Staffbase ou no externalID, se for adicionado para o usuário.

Usuário: Excluir usuário

Exclui o usuário especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
userID True string

O ID pode ser baseado no UserID gerado automaticamente pela plataforma Staffbase ou no externalID, se for adicionado para o usuário.

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

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

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
userID True string

O ID pode ser baseado no UserID gerado automaticamente pela plataforma Staffbase ou no externalID, se for adicionado para o usuário.

Devoluções

Body
userData

Usuário: Obter lista de usuários

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

Parâmetros

Name Chave Necessá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 serach em qualquer campo de perfil.

Definições

mediaData

Name Caminho Tipo Description
id
id string

Este é o ID do ativo.

ID do proprietário
ownerID string

Este é o ID do proprietário deste ativo.

identificação dos pais
parentID string

Este é o ID do ativo de mídia pai.

identificação pública
publicID string

Este é o ID público para acessar o ativo.

tipo
resourceInfo.type string

Este é o tipo de recurso de ativo.

bytes
resourceInfo.bytes integer

Este é o tamanho do recurso (em bytes).

Largura
resourceInfo.width integer

Esta é a largura do recurso.

altura
resourceInfo.height integer

Esta é a altura do recurso.

URL
resourceInfo.url string

Este é o url do recurso.

format
resourceInfo.format string

Este é o formato do recurso.

mimeType
resourceInfo.mimeType string

Este é o tipo MIME de recurso.

fileName
fileName string

Este é o nome do arquivo de mídia.

title
title string

Este é o título da mídia.

etiqueta
label string

Este é o rótulo da mídia.

criado
created string

A data de criação do ativo.

userData

Name Caminho Tipo Description
id
id string

O ID do usuário

ID externo
externalID string

O ID externo do usuário

primeiroNome
firstName string

O nome próprio do utilizador

sobrenome
lastName string

O sobrenome do usuário

publicEmailAddress
publicEmailAddress string

O e-mail público do usuário

região
config.locale string

A localidade do usuário

E-mails
emails array of object

Informações de e-mail do usuário

e-mail
emails.value string

O endereço de e-mail

primário
emails.primary boolean

É o e-mail principal?

IDs de grupo
groupIDs array of string
posição
position string

A posição do utilizador

departamento
department string

O departamento do utilizador

localização
location string

A localização do utilizador

Número de telefone
phoneNumber string

O número de telefone do utilizador

criado
created string

A data de criação do usuário

atualizado
updated string

A data de atualização do usuário

ativado
activated string

O usuário está ativado?

pós-dados

Name Caminho Tipo Description
id
id string

O ID da postagem.

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

O conteúdo da postagem, que está localizado.

imagem
contents.image imageObject
teaser
contents.teaser string

O post teaser, que está localizado.

title
contents.title string

O título do post, que está localizado.

região
contents.locale string

Esta é a localidade do item.

id
channel.id string

Este é o ID do canal.

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

Este é o título do canal, que está localizado.

região
channel.config.localization.locale string

Esta é a localidade do título do canal.

publicado em
published string

A data de publicação do post.

criado
created string

A data de criação do post.

atualizado
updated string

A data atualizada da postagem.

authorObject

Name Caminho Tipo Description
primeiroNome
firstName string

Este é o primeiro nome do autor.

id
id string

Este é o ID do autor.

sobrenome
lastName string

Este é o sobrenome do autor.

URL
avatar.original.url string

Este é o url original da imagem do avatar do autor.

Largura
avatar.original.width integer

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

altura
avatar.original.height integer

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

size
avatar.original.size integer

Esta é a imagem original do avatar do autor sie (em bytes).

format
avatar.original.format string

Este é o formato original do avatar do autor.

mimeType
avatar.original.mimeType string

Esta é a imagem original do avatar athor mimeType.

criado
avatar.original.created string

Esta é a data original criada pelo avatar do autor.

URL
avatar.icon.url string

Este é o url do ícone do avatar do autor.

Largura
avatar.icon.width integer

Esta é a largura do ícone do avatar do autor.

altura
avatar.icon.height integer

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

format
avatar.icon.format string

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

mimeType
avatar.icon.mimeType string

Este é o ícone do avatar do autor mimeType.

URL
avatar.thumb.url string

Este é o url do polegar do avatar do autor.

Largura
avatar.thumb.width integer

Esta é a largura do polegar do avatar do autor.

altura
avatar.thumb.height integer

Esta é a altura do polegar do avatar do autor.

format
avatar.thumb.format string

Este é o formato de polegar avatar do autor.

mimeType
avatar.thumb.mimeType string

Este é o avatar athor polegar mimeType.

identificação pública
avatar.publicID string

Este é o ID público do avatar do autor.

imageObject

Name Caminho Tipo Description
URL
original.url string

Este é o url original da imagem.

Largura
original.width integer

Esta é a largura original da imagem.

altura
original.height integer

Esta é a altura original da imagem.

size
original.size integer

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

format
original.format string

Este é o formato original da imagem.

mimeType
original.mimeType string

Esta é a imagem original mimeType.

URL
original_scaled.url string

Este é o url original da imagem.

Largura
original_scaled.width integer

Esta é a largura original da imagem.

altura
original_scaled.height integer

Esta é a altura original da imagem.

format
original_scaled.format string

Este é o formato original da imagem.

mimeType
original_scaled.mimeType string

Esta é a imagem original mimeType.

URL
compact.url string

Esta é a url compacta da imagem.

Largura
compact.width integer

Esta é a largura compacta da imagem.

altura
compact.height integer

Esta é a altura compacta da imagem.

format
compact.format string

Este é o formato compacto da imagem.

mimeType
compact.mimeType string

Esta é a imagem compacta mimeType.