Staffbase （预览版）

借助 Staffbase 连接器，可以桥接不同的工具和系统，并将 Staffbase 平台集成到自动化工作流中。这包括员工应用或 Intranet 以自动执行流程、按计划运行任务，或在事件发生时通知用户。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	Staffbase 支持
URL	https://www.staffbase.com
Email	support@staffbase.com

连接器元数据
发布者	Staffbase GmbH
网站	https://www.staffbase.com
隐私策略	https://staffbase.com/en/privacy-policy/
类别	通信;人力资源

Staffbase 连接器

借助 Power Automate 的 Staffbase 连接器，可以弥合不同工具和系统之间的差距，并在自动化工作流中包含 Staffbase 平台。利用自动化工作流的强大功能，包括员工应用或 Intranet 来自动执行流程、按计划运行任务，或通知用户事件发生时。

先决条件

具有自定义连接器功能的Microsoft Power Apps 或 Power Automate 计划
组织的 Staffbase 许可证
组织在 Staffbase 平台上的管理员角色
用于配置身份验证的 API 令牌
有关托管应用程序的 Staffasbe 基础结构的信息，请联系 support@staffbase.com 以获取详细信息

支持的作

ChannelsGetList

获取新闻频道列表

ChannelsGetPosts

获取指定频道中的帖子列表

ChannelsPostPost

将帖子发送到特定频道

CommentsGet

从 Staffbase 实例获取所有注释

MediaGet

从 Staffbase 实例获取所有媒体

MediaGetByID

按 ID 获取媒体

MediaDelete

按 ID 删除媒体

NotificationPost

向用户发送通知

PostsGetAll

获取文章列表

PostsGetByID

按 ID 获取帖子

PostsDelete

删除帖子

PostsPut

更新帖子

UserGetAll

获取用户列表

UserPost

按名字、姓氏和 eMail 邀请用户

UserGetByID

获取用户信息

User_delete

按 ID 删除用户

UserPut

更新用户信息

UserPostRecovery

发送恢复电子邮件

ProxyVersionGet

仅供内部使用，检查当前的 API 代理版本

获取凭据

若要在 Staffbase 平台和 Power Automate 中创建的工作流之间进行基本身份验证，需要一个 API 令牌。可以从 Staffbase Experience Studio 生成 API 令牌。

入门

使用基本身份验证和托管 URL 配置连接器。

在 Power Automate 中，导航到连接器。
搜索 Staffbase 连接器。
单击 Staffbase 连接器。此时会打开用于配置连接器的对话框。
在 API 令牌字段中，使用以下语法添加 API 令牌：基本 [API-Token]

注意：需要在“基本”和 API 令牌之间添加空白空间。

在“主机 ID”字段中，输入托管 Staffbase 平台的基础结构的标识符：

德国基础设施： de1
国际基础设施： us1

有关详细信息，请访问 Staffbase 支持门户。

已知问题和限制

Staffbase 连接器目前不支持所有 Staffbase API 功能。有关 Staffbase API 的详细信息，请访问 Staffbase 开发人员门户。

常见问题解答

可以使用 Staffbase 连接器自动执行哪些业务工作流？

可以使用 Staffbase 连接器自动执行许多业务流程。例如，在员工应用或 Intranet 中直接通知员工，并在其他工具中执行作时通知员工。在此处了解有关此类业务用例的详细信息。

是否有教程可帮助你开始使用 Staffbase 连接器的自动化工作流？

Staffbase 提供了使用 Forms 插件和 Staffbase 连接器自动执行设施管理的教程。了解有关如何在本节中设置它的所有内容。

部署说明

运行以下命令并按照提示作：

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

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
API-Key	securestring	Staffbase 实例的“API-Key”	True
宿主 ID	字符串	指定托管 ID：hostingID	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

代理：获取版本	返回当前代理版本。
媒体：删除媒体	删除当前上下文中的指定媒体。
媒体：按 ID 获取媒体	按其 ID 获取单个媒体的元数据。
媒体：获取所有媒体	请求当前上下文中提供的所有媒体的说明。
帖子：按 ID 获取帖子	请求指定的帖子，包括一组注释。
文章：删除帖子	从系统中删除帖子。
文章：更新帖子	更新帖子，仅更改字段（增量）。
文章：获取文章列表	获取 API 令牌可访问的帖子列表。
文章：获取评论	获取注释列表。
用户：删除用户	删除指定的用户。
用户：发送恢复电子邮件	向指定用户发送恢复电子邮件。
用户：更新用户信息	更新用户信息。
用户：获取用户信息	按用户 ID 获取特定用户信息。
用户：获取用户列表	根据 API 访问令牌获取用户列表。
用户：邀请用户	用户将收到要注册的电子邮件。
通知：发送通知	向指定用户发送通知。
频道：将帖子发送到特定频道	将帖子发送到特定新闻频道。
频道：获取指定频道内的帖子列表	获取指定频道中的帖子列表。
频道：获取新闻频道列表	获取新闻频道列表。

代理：获取版本

操作 ID:: ProxyVersionGet

返回当前代理版本。

媒体：删除媒体

操作 ID:: MediaDelete

删除当前上下文中的指定媒体。

参数

名称	密钥	必需	类型	说明
MediumID	mediumID	True	string	按其 ID 删除介质。虽然这会立即从服务器中删除资源，但 CDN 仍可能通过 resourceInfo.url 中所述的 URL 传递内容，直到 CDN 失效。

媒体：按 ID 获取媒体

操作 ID:: MediaGetByID

按其 ID 获取单个媒体的元数据。

参数

名称	密钥	必需	类型	说明
MediumID	mediumID	True	string	请求有关特定介质的信息。

Body: mediaData

媒体：获取所有媒体

操作 ID:: MediaGet

请求当前上下文中提供的所有媒体的说明。

参数

名称	密钥	必需	类型	说明
限度	limit		integer	限制此处的项目数。
Offset	offset		integer	设置查询的偏移量。

名称	路径	类型	说明
总	total	integer	找到的资产总数。
limit	limit	integer	返回的项量。
偏移	offset	integer	用于从此数字开始获取项的当前定义的偏移量。
数据	data	array of mediaData

帖子：按 ID 获取帖子

操作 ID:: PostsGetByID

请求指定的帖子，包括一组注释。

参数

名称	密钥	必需	类型	说明
PageID	pageID	True	string	这是帖子的 ID。

Body: postData

文章：删除帖子

操作 ID:: PostsDelete

从系统中删除帖子。

参数

名称	密钥	必需	类型	说明
PageID	pageID	True	string	这可以是 API 定义的帖子 ID，也可以是设置 post externalID。

名称	路径	类型	说明
标识符	identifier	integer	删除的标识符。
状态码	statusCode	integer	作的状态代码。
消息	message	string	作的消息。
类型	type	string	操作的类型。

文章：更新帖子

操作 ID:: PostsPut

更新帖子，仅更改字段（增量）。

参数

名称	密钥	必需	类型	说明
PageID	pageID	True	string	这可以是 API 定义的帖子 ID，也可以是设置 post externalID。
externalID	externalID		string	可选：在此处输入外部 ID。
区域设置	locale		string	插入区域设置，例如de_DE、en_US等。
内容	content		string	在此处输入新闻内容。
图像	image		string	在此处输入图像的链接。
传情	teaser		string	在此处输入挑逗。
title	title		string	在此处输入游戏。
发表	published		string	输入在此处发布的日期。

文章：获取文章列表

操作 ID:: PostsGetAll

获取 API 令牌可访问的帖子列表。

参数

名称	密钥	类型	说明
Query	query	string	可用于搜索帖子内容的字符串。
限度	limit	integer	应返回的项目量（默认值和最大值 100）。
Offset	offset	integer	定义一个偏移量，用于从此数字开始获取项。
管理	manageable	boolean	给定帖子内容类型的可选筛选器。默认为不筛选。
内容类型	contentType	string	给定帖子内容类型的可选筛选器。（默认不筛选）

名称	路径	类型	说明
总	total	integer	找到的帖子总数。
limit	limit	integer	返回的项量。
偏移	offset	integer	用于从此数字开始获取项的当前定义的偏移量。
数据	data	array of postData

文章：获取评论

操作 ID:: CommentsGet

获取注释列表。

参数

名称	密钥	类型	说明
Manage	manage	boolean	如果为 true 且令牌角色允许管理批注，也不会在列表中显示已发布的注释。
限度	limit	integer	应返回的项目量（默认值和最大值 100）。
Offset	offset	integer	定义一个偏移量，用于从此数字开始获取项。
过滤器	filter	string	按 SCIM2 格式筛选，支持部分。目前仅支持平面结构（无嵌套子句）和比较子句，例如 eq = “equals”，gt = “大于”， ge = “大于或等于”， lt = “less than”， le = “less than or equals” 。对于支持的注释筛选器字段：创建和更新。这些字段的值可以在 UTC DateTime 字符串表示或 Unix 纪元的长毫秒数中提供。示例 1：filter=updated ge “2020-11-26T10：14：48.947Z” and updated le “2020-11-26T10：14：48.947Z”。在此示例中，DateTime 范围筛选器应用于带有 ge 和 le 比较子句和布尔子句的更新字段。示例 2：filter=created gt gt“2020-11-26T10：14：48.947Z”。获取在指向日期之后创建的所有注释。

名称	路径	类型	说明
总	total	integer	找到的批注总数。
limit	limit	integer	返回的项量。
偏移	offset	integer	用于从此数字开始获取项的当前定义的偏移量。
数据	data	array of object
id	data.id	string	这是注释的 ID。
parentID	data.parentID	string	批注的父级的 ID 可以是帖子或批注。
父类型	data.parentType	string	父类型可以是帖子或批注。
注释文本	data.text	string	这是注释内容/测试本身。
post ID	data.rootID	string	这是此批注相关的帖子的 ID
作者	data.author	authorObject
总	data.likes.total	integer	这是注释的赞数。
isLiked	data.likes.isLiked	string	此评论是否赞？
已创建	data.created	string	批注的创建日期。
更新	data.updated	string	批注的更新日期。
图像	data.image	imageObject

用户：删除用户

操作 ID:: UserDelete

删除指定的用户。

参数

名称	密钥	必需	类型	说明
UserID	userID	True	string	ID 可以基于 Staffbase 平台或 externalID 自动生成的 UserID（如果为用户添加）。

用户：发送恢复电子邮件

操作 ID:: UserPostRecovery

向指定用户发送恢复电子邮件。

参数

名称	密钥	必需	类型	说明
UserID	userID	True	string	ID 可以基于 Staffbase 平台或 externalID 自动生成的 UserID（如果为用户添加）。

用户：更新用户信息

操作 ID:: UserPut

更新用户信息。

参数

名称	密钥	必需	类型	说明
UserID	userID	True	string	ID 可以基于 Staffbase 平台或 externalID 自动生成的 UserID（如果为用户添加）。
id	id		string	用户的 ID
externalID	externalID		string	用户的外部 ID
firstName	firstName		string	用户的名字
lastName	lastName		string	用户的姓氏
publicEmailAddress	publicEmailAddress		string	用户的公共 eMail
区域设置	locale		string	用户的区域设置
电子邮件	value		string	电子邮件地址
首要	primary		boolean	它是主电子邮件吗？
groupIDs	groupIDs		array of string
位置	position		string	用户的位置
部门	department		string	用户的部门
位置	location		string	用户的位置
电话号码	phoneNumber		string	用户的电话号码
已创建	created		string	用户的创建日期
更新	updated		string	用户的更新日期
激活	activated		string	用户是否已激活？

Body: userData

用户：获取用户信息

操作 ID:: UserGetByID

按用户 ID 获取特定用户信息。

参数

名称	密钥	必需	类型	说明
UserID	userID	True	string	ID 可以基于 Staffbase 平台或 externalID 自动生成的 UserID（如果为用户添加）。

Body: userData

用户：获取用户列表

操作 ID:: UserGetAll

根据 API 访问令牌获取用户列表。

参数

名称	密钥	必需	类型	说明
SCIM 表示法可用于筛选	filter		string	SCIM 表示法可用于筛选。
全文搜索可以与筛选器组合使用	query		string	在这里，可以在任何配置文件字段中进行 serach。

用户：邀请用户

操作 ID:: UserPost

用户将收到要注册的电子邮件。

参数

名称	密钥	类型	说明
电子邮件	email	string	这是用户的电子邮件地址。
firstName	firstName	string	这是用户的名字。
lastName	lastName	string	这是用户的姓氏。

通知：发送通知

操作 ID:: NotificationPost

向指定用户发送通知。

参数

名称	密钥	类型	说明
访问器 Ids	accessorIds	array of string
区域设置	locale	string	插入区域设置，例如de_DE、en_US等。
title	title	string	插入依赖于语言的标题。
链接	link	string	Optinal：在此处插入链接。

名称	路径	类型	说明
id	id	string	这是通知的 ID。
访问器 Ids	recipients.accessorIds	array of string	这是收件人 ID 的列表。
内容	content	array of object
title	content.title	string	本地化的通知的标题。
区域设置	content.locale	string	这是游戏的区域设置。
链接	link	string	这是通知链接。
类型	type	string	这是通知类型。
createdAt	createdAt	string	通知的创建日期。
已创建	created	string	通知的创建日期。

频道：将帖子发送到特定频道

操作 ID:: ChannelsPostPost

将帖子发送到特定新闻频道。

参数

名称	密钥	必需	类型	说明
ChannelID	channelID	True	string	在此处插入通道 ID。
externalID	externalID		string	可选：在此处输入外部 ID。
区域设置	locale		string	插入区域设置，例如de_DE、en_US等。
内容	content		string	在此处输入新闻内容。
图像（链接）	image		string	在此处输入图像链接。
传情	teaser		string	在此处输入挑逗。
title	title		string	在此处输入游戏。
发表	published		string	输入在此处发布的日期。

频道：获取指定频道内的帖子列表

操作 ID:: ChannelsGetPosts

获取指定频道中的帖子列表。

参数

名称	密钥	必需	类型	说明
ChannelID	channelID	True	string	在此处插入通道 ID，例如由 getChannels 检索。
限度	limit		integer	应返回的项目量（默认值和最大值 100）。
Offset	offset		integer	定义一个偏移量，用于从此数字开始获取项。

名称	路径	类型	说明
总	total	integer	找到的帖子总数。
limit	limit	integer	返回的项量。
偏移	offset	integer	用于从此数字开始获取项的当前定义的偏移量。
数据	data	array of postData

频道：获取新闻频道列表

操作 ID:: ChannelsGetList

获取新闻频道列表。

名称	路径	类型	说明
总	total	integer	找到的通道总数。
limit	limit	integer	返回的项量。
偏移	offset	integer	用于从此数字开始获取项的当前定义的偏移量。
数据	data	array of object
id	data.id	string	这是通道的 ID。
本地化	data.config.localization	array of object
title	data.config.localization.title	string	本地化的频道标题。
区域设置	data.config.localization.locale	string	这是频道标题的区域设置。
spaceID	data.spaceID	string	为其分配通道的空间的 ID。
已创建	data.created	string	通道的创建日期。
发表	data.published	string	频道的发布日期。
更新	data.updated	string	通道的更新日期。

定义

mediaData

名称	路径	类型	说明
id	id	string	这是资产的 ID。
ownerID	ownerID	string	这是此资产所有者的 ID。
parentID	parentID	string	这是父媒体资产的 ID。
publicID	publicID	string	这是用于访问资产的公共 ID。
类型	resourceInfo.type	string	这是资产资源类型。
字节	resourceInfo.bytes	integer	这是资源大小（以字节为单位）。
width	resourceInfo.width	integer	这是资源宽度。
身高	resourceInfo.height	integer	这是资源高度。
网址	resourceInfo.url	string	这是资源 URL。
格式	resourceInfo.format	string	这是资源格式。
MIME类型	resourceInfo.mimeType	string	这是资源 MIME 类型。
fileName	fileName	string	这是媒体文件名。
title	title	string	这是媒体标题。
标签	label	string	这是媒体标签。
已创建	created	string	资产的创建日期。

用户数据

名称	路径	类型	说明
id	id	string	用户的 ID
externalID	externalID	string	用户的外部 ID
firstName	firstName	string	用户的名字
lastName	lastName	string	用户的姓氏
publicEmailAddress	publicEmailAddress	string	用户的公共 eMail
区域设置	config.locale	string	用户的区域设置
电子邮件	emails	array of object	用户电子邮件信息
电子邮件	emails.value	string	电子邮件地址
首要	emails.primary	boolean	它是主电子邮件吗？
groupIDs	groupIDs	array of string
位置	position	string	用户的位置
部门	department	string	用户的部门
位置	location	string	用户的位置
电话号码	phoneNumber	string	用户的电话号码
已创建	created	string	用户的创建日期
更新	updated	string	用户的更新日期
激活	activated	string	用户是否已激活？

postData

名称	路径	类型	说明
id	id	string	帖子的 ID。
作者	author	authorObject
内容	contents	array of object
内容	contents.content	string	本地化的帖子内容。
图像	contents.image	imageObject
传情	contents.teaser	string	后期取笑器，这是本地化的。
title	contents.title	string	本地化的帖子标题。
区域设置	contents.locale	string	这是项的区域设置。
id	channel.id	string	这是通道的 ID。
本地化	channel.config.localization	array of object
title	channel.config.localization.title	string	这是本地化的频道标题。
区域设置	channel.config.localization.locale	string	这是频道标题的区域设置。
发表	published	string	帖子的发布日期。
已创建	created	string	帖子的创建日期。
更新	updated	string	帖子的更新日期。

authorObject

名称	路径	类型	说明
firstName	firstName	string	这是作者的名字。
id	id	string	这是作者的 ID。
lastName	lastName	string	这是作者的姓氏。
网址	avatar.original.url	string	这是作者头像图像原始 URL。
width	avatar.original.width	integer	这是作者头像图像的原始宽度。
身高	avatar.original.height	integer	这是作者头像图像的原始高度。
size	avatar.original.size	integer	这是作者头像原始 sie （以字节为单位）。
格式	avatar.original.format	string	这是作者头像原始格式。
MIME类型	avatar.original.mimeType	string	这是 athor avatar 图像原始 mimeType。
已创建	avatar.original.created	string	这是作者头像原始创建日期。
网址	avatar.icon.url	string	这是作者虚拟形象图标 URL。
width	avatar.icon.width	integer	这是作者虚拟形象图标宽度。
身高	avatar.icon.height	integer	这是作者头像图标高度。
格式	avatar.icon.format	string	这是作者头像图标格式。
MIME类型	avatar.icon.mimeType	string	这是作者虚拟形象图标 mimeType。
网址	avatar.thumb.url	string	这是作者头像指纹 URL。
width	avatar.thumb.width	integer	这是作者头像拇指宽度。
身高	avatar.thumb.height	integer	这是作者头像大拇指高度。
格式	avatar.thumb.format	string	这是作者头像指纹格式。
MIME类型	avatar.thumb.mimeType	string	这是 athor avatar thumb mimeType。
publicID	avatar.publicID	string	这是作者头像公共 ID。

imageObject

名称	路径	类型	说明
网址	original.url	string	这是图像原始 URL。
width	original.width	integer	这是图像的原始宽度。
身高	original.height	integer	这是图像的原始高度。
size	original.size	integer	这是图像原始大小（以字节为单位）。
格式	original.format	string	这是图像原始格式。
MIME类型	original.mimeType	string	这是图像原始 mimeType。
网址	original_scaled.url	string	这是图像原始 URL。
width	original_scaled.width	integer	这是图像的原始宽度。
身高	original_scaled.height	integer	这是图像的原始高度。
格式	original_scaled.format	string	这是图像原始格式。
MIME类型	original_scaled.mimeType	string	这是图像原始 mimeType。
网址	compact.url	string	这是图像压缩 URL。
width	compact.width	integer	这是图像压缩宽度。
身高	compact.height	integer	这是图像压缩高度。
格式	compact.format	string	这是图像压缩格式。
MIME类型	compact.mimeType	string	这是映像压缩 mimeType。

通过