Staffbase （預覽版）

透過 Staffbase 連接器，您可以橋接不同的工具和系統，並將 Staffbase 平台整合到您的自動化工作流程中。這包括您的員工應用程式或內部網路，用於自動化流程、按計劃執行任務或在事件發生時通知使用者。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	員工基礎支援
URL	https://www.staffbase.com
Email	support@staffbase.com

連接器中繼資料
Publisher	斯塔夫基地有限公司
網站	https://www.staffbase.com
隱私策略	https://staffbase.com/en/privacy-policy/
類別	傳達;人力資源

Staffbase 連接器

使用 Power Automate 的 Staffbase 連接器，您可以彌合不同工具和系統之間的差距，並將 Staffbase 平台包含在自動化工作流程中。利用自動化工作流程的強大功能（包括您的員工應用程式或內部網路）來自動化流程、按計劃執行任務或在事件發生時通知使用者。

先決條件

具有自訂連接器功能的 Microsoft Power Apps 或 Power Automate 方案
您組織的 Staffbase 授權
組織在 Staffbase 平台上的管理員角色
用於設定驗證的 API 權杖
有關您的應用程式託管在哪個 Staffasbe 基礎架構上的信息，請聯絡以 support@staffbase.com 獲取更多資訊

支援的作業

通道GetList

取得新聞頻道清單

頻道GetPosts

取得指定頻道內的貼文清單

頻道PostPost

將貼文傳送至特定頻道

評論獲取

從您的 Staffbase 實例中獲取所有評論

媒體獲取

從您的 Staffbase 執行個體取得所有媒體

MediaGetByID

依 ID 取得媒體

媒體刪除

依 ID 刪除媒體

通知貼文

傳送通知給使用者

貼文GetAll

取得貼文清單

貼文GetByID

按 ID 獲取帖子

帖子刪除

移除貼文

貼文放

更新貼文

UserGetAll

取得使用者清單

用戶帖子

以名字、姓氏和電子郵件邀請使用者

UserGetByID

取得使用者資訊

User_delete

依 ID 刪除使用者

用戶放置

更新使用者資訊

用戶恢復後

傳送備援電子郵件

ProxyVersion取得

僅供內部使用，查看當前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 連接器自動化。例如，當其他工具中發生操作時，直接在員工應用程序或內部網中通知您的員工。在此處了解有關此類業務用例的更多信息。

是否有教學課程可協助我開始使用 Staffbase 連接器進行自動化工作流程？

Staffbase 提供使用我們的 Forms 外掛程式和 Staffbase 連接器來自動化設施管理的教學課程。在本節中瞭解如何設定。

部署指示

執行下列命令並遵循提示：

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

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API-Key	securestring	Staffbase 實例的 “API-Key”	對
託管 ID	字串	指定您的託管 ID：hostingID	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

代理：取得版本	傳回目前的 Proxy 版本。
使用者：傳送備援電子郵件	傳送修復電子郵件給指定的使用者。
使用者：刪除使用者	刪除指定的使用者。
使用者：取得使用者清單	根據 API 存取權杖取得使用者清單。
使用者：取得使用者資訊	通過其用戶 ID 獲取特定的用戶信息。
使用者：更新使用者資訊	更新使用者資訊。
使用者：邀請使用者	用戶將收到一封註冊電子郵件。
媒體：依 ID 取得媒體	依單一媒體的 ID 取得中繼資料。
媒體：刪除媒體	刪除目前內容中指定的媒體。
媒體：取得所有媒體	要求目前內容中所有可用媒體的描述。
帖子：獲取評論	取得評論清單。
貼文：依 ID 取得貼文	要求指定的貼文，包括一組註解。
貼文：取得貼文清單	取得API權杖可存取的貼文清單。
貼文：更新貼文	更新貼文，僅變更欄位（增量）。
貼文：移除貼文	從系統中移除貼文。
通知：傳送通知	傳送通知給指定的使用者。
頻道：取得新聞頻道清單	獲取新聞頻道列表。
頻道：將貼文傳送至特定頻道	將帖子發送到特定新聞頻道。
頻道：獲取指定頻道內的帖子列表	獲取指定頻道內的帖子列表。

代理：取得版本

作業識別碼：: ProxyVersionGet

傳回目前的 Proxy 版本。

使用者：傳送備援電子郵件

作業識別碼：: UserPostRecovery

傳送修復電子郵件給指定的使用者。

參數

名稱	機碼	必要	類型	Description
UserID	userID	True	string	ID 可以基於 Staffbase 平台自動產生的 UserID 或 externalID （如果已為使用者新增）。

使用者：刪除使用者

作業識別碼：: UserDelete

刪除指定的使用者。

參數

名稱	機碼	必要	類型	Description
UserID	userID	True	string	ID 可以基於 Staffbase 平台自動產生的 UserID 或 externalID （如果已為使用者新增）。

使用者：取得使用者清單

作業識別碼：: UserGetAll

根據 API 存取權杖取得使用者清單。

參數

名稱	機碼	必要	類型	Description
SCIM 表示法可用於過濾	filter		string	SCIM 表示法可用於過濾。
全文檢索搜尋可以與過濾器結合使用	query		string	在這裡，您可以在任何配置文件字段中進行搜索。

使用者：取得使用者資訊

作業識別碼：: UserGetByID

通過其用戶 ID 獲取特定的用戶信息。

參數

名稱	機碼	必要	類型	Description
UserID	userID	True	string	ID 可以基於 Staffbase 平台自動產生的 UserID 或 externalID （如果已為使用者新增）。

傳回

身體: userData

使用者：更新使用者資訊

作業識別碼：: UserPut

更新使用者資訊。

參數

名稱	機碼	必要	類型	Description
UserID	userID	True	string	ID 可以基於 Staffbase 平台自動產生的 UserID 或 externalID （如果已為使用者新增）。
識別碼	id		string	使用者的ID
外部識別碼	externalID		string	使用者的外部 ID
名字	firstName		string	使用者的名字
lastName	lastName		string	使用者的姓氏
publicEmail地址	publicEmailAddress		string	使用者的公開電子郵件
地區設定	locale		string	使用者的地區設定
電子郵件	value		string	電子郵件位址
主要	primary		boolean	是主要電子郵件嗎？
群組 ID	groupIDs		array of string
位置	position		string	用戶的位置
部門	department		string	使用者的部門
位置	location		string	使用者的位置
電話號碼	phoneNumber		string	使用者的電話號碼
創建	created		string	使用者的建立日期
更新	updated		string	使用者的更新日期
已啟動	activated		string	使用者是否已啟用？

傳回

身體: userData

使用者：邀請使用者

作業識別碼：: UserPost

用戶將收到一封註冊電子郵件。

參數

名稱	機碼	類型	Description
電子郵件	email	string	這是使用者的電子郵件地址。
名字	firstName	string	這是使用者的名字。
lastName	lastName	string	這是使用者的姓氏。

媒體：依 ID 取得媒體

作業識別碼：: MediaGetByID

依單一媒體的 ID 取得中繼資料。

參數

名稱	機碼	必要	類型	Description
中ID	mediumID	True	string	請求特定媒體的資訊。

傳回

身體: mediaData

媒體：刪除媒體

作業識別碼：: MediaDelete

刪除目前內容中指定的媒體。

參數

名稱	機碼	必要	類型	Description
中ID	mediumID	True	string	依媒體的 ID 刪除媒體。雖然這會立即從我們的伺服器中刪除資源，但 CDN 仍可能透過 resourceInfo.url 中規定的 URL 傳遞內容，直到 CDN 失效。

媒體：取得所有媒體

作業識別碼：: MediaGet

要求目前內容中所有可用媒體的描述。

參數

名稱	機碼	必要	類型	Description
限制	limit		integer	在這裡限制項目數量。
Offset	offset		integer	設定查詢的偏移量。

傳回

名稱	路徑	類型	Description
總計	total	integer	找到的資產總數。
limit	limit	integer	退回的項目數量。
位移	offset	integer	目前定義的偏移，用於取得從此數字開始的項目。
資料	data	array of mediaData

帖子：獲取評論

作業識別碼：: CommentsGet

取得評論清單。

參數

名稱	機碼	類型	Description
Manage	manage	boolean	當 true 且權杖角色允許管理註解時，清單中也會顯示未發佈的註解。
限制	limit	integer	應傳回的專案數量（預設值和最多 100 個）。
Offset	offset	integer	定義偏移，以取得從此數字開始的項目。
Filter	filter	string	以 SCIM2 格式篩選，並部分支援。目前僅支援平面結構（無巢狀子句）和比較子句，例如 eq = “equals”、gt = “greater than”、ge = “greater than or equals”、lt = “less than”、le = “小於或等於”。對於註解，支援的篩選欄位包括：已建立和更新。這些欄位的值可以以 UTC DateTime 字串表示形式或 Unix 紀元的長毫秒數提供。範例 1：filter=updated ge “2020-11-26T10：14：48.947Z” 並更新 le “2020-11-26T10：14：48.947Z”。在此範例中，DateTime 範圍篩選器會套用至具有 ge 和 le 比較子句和和布林子句的更新欄位。範例 2：filter=created gt “2020-11-26T10：14：48.947Z”。取得指定日期之後建立的所有評論。

傳回

名稱	路徑	類型	Description
總計	total	integer	找到的註解總數。
limit	limit	integer	退回的項目數量。
位移	offset	integer	目前定義的偏移，用於取得從此數字開始的項目。
資料	data	array of object
識別碼	data.id	string	這是註解的 ID。
家長標識碼	data.parentID	string	註解父系的識別碼可以是貼文或註解。
父類型	data.parentType	string	父類型可以是貼文或註解。
註解文字	data.text	string	這是評論內容/測試本身。
貼文ID	data.rootID	string	這是此評論相關的帖子的 ID
作者	data.author	authorObject
總計	data.likes.total	integer	這是評論點贊數。
是喜歡的	data.likes.isLiked	string	這個評論喜歡嗎？
創建	data.created	string	註解的建立日期。
更新	data.updated	string	註解的更新日期。
圖片	data.image	imageObject

貼文：依 ID 取得貼文

作業識別碼：: PostsGetByID

要求指定的貼文，包括一組註解。

參數

名稱	機碼	必要	類型	Description
頁面標識碼	pageID	True	string	這是貼文的 ID。

傳回

身體: postData

貼文：取得貼文清單

作業識別碼：: PostsGetAll

取得API權杖可存取的貼文清單。

參數

名稱	機碼	類型	Description
Query	query	string	可用於搜尋貼文內容的字串。
限制	limit	integer	應傳回的專案數量（預設值和最多 100 個）。
Offset	offset	integer	定義偏移，以取得從此數字開始的項目。
易於管理	manageable	boolean	指定貼文內容型別的選用篩選器。預設為不篩選。
內容類型	contentType	string	指定貼文內容型別的選用篩選器。（預設為不過濾）

傳回

名稱	路徑	類型	Description
總計	total	integer	找到的貼文總數。
limit	limit	integer	退回的項目數量。
位移	offset	integer	目前定義的偏移，用於取得從此數字開始的項目。
資料	data	array of postData

貼文：更新貼文

作業識別碼：: PostsPut

更新貼文，僅變更欄位（增量）。

參數

名稱	機碼	必要	類型	Description
頁面標識碼	pageID	True	string	這可以是 API 定義的貼文 ID，也可以是設定貼文 externalID。
外部識別碼	externalID		string	選用項目：在此處輸入外部 ID。
地區設定	locale		string	插入語言環境，例如de_DE、en_US等。
內容	content		string	在此處輸入新聞內容。
圖片	image		string	在此處輸入圖像鏈接。
預告片	teaser		string	在這裡輸入您的預告片。
title	title		string	在此處輸入您的標題。
發表	published		string	在此處輸入您的發布日期。

貼文：移除貼文

作業識別碼：: PostsDelete

從系統中移除貼文。

參數

名稱	機碼	必要	類型	Description
頁面標識碼	pageID	True	string	這可以是 API 定義的貼文 ID，也可以是設定貼文 externalID。

傳回

名稱	路徑	類型	Description
識別碼	identifier	integer	刪除的識別碼。
StatusCode	statusCode	integer	動作的狀態碼。
訊息	message	string	動作的訊息。
型別	type	string	動作的類型。

通知：傳送通知

作業識別碼：: NotificationPost

傳送通知給指定的使用者。

參數

名稱	機碼	類型	Description
accessorIds	accessorIds	array of string
地區設定	locale	string	插入語言環境，例如de_DE、en_US等。
title	title	string	插入語言相依標題。
連結	link	string	選項：在此處插入鏈接。

傳回

名稱	路徑	類型	Description
識別碼	id	string	這是通知的 ID。
accessorIds	recipients.accessorIds	array of string	這是收件者ID的清單。
內容	content	array of object
title	content.title	string	當地語系化的通知標題。
地區設定	content.locale	string	這是標題的地區設定。
連結	link	string	這是通知連結。
型別	type	string	這是通知類型。
創建於	createdAt	string	通知的建立日期。
創建	created	string	通知的建立日期。

頻道：取得新聞頻道清單

作業識別碼：: ChannelsGetList

獲取新聞頻道列表。

傳回

名稱	路徑	類型	Description
總計	total	integer	找到的通道總數。
limit	limit	integer	退回的項目數量。
位移	offset	integer	目前定義的偏移，用於取得從此數字開始的項目。
資料	data	array of object
識別碼	data.id	string	這是通道的 ID。
當地語系化	data.config.localization	array of object
title	data.config.localization.title	string	本地化的頻道標題。
地區設定	data.config.localization.locale	string	這是頻道標題的地區設定。
空間ID	data.spaceID	string	頻道指派至的空間 ID。
創建	data.created	string	頻道的建立日期。
發表	data.published	string	頻道的發佈日期。
更新	data.updated	string	頻道的更新日期。

頻道：將貼文傳送至特定頻道

作業識別碼：: ChannelsPostPost

將帖子發送到特定新聞頻道。

參數

名稱	機碼	必要	類型	Description
頻道ID	channelID	True	string	在此處插入頻道 ID。
外部識別碼	externalID		string	選用項目：在此處輸入外部 ID。
地區設定	locale		string	插入語言環境，例如de_DE、en_US等。
內容	content		string	在此處輸入新聞內容。
圖片（鏈接）	image		string	在此處輸入圖像鏈接。
預告片	teaser		string	在這裡輸入您的預告片。
title	title		string	在此處輸入您的標題。
發表	published		string	在此處輸入您的發布日期。

頻道：獲取指定頻道內的帖子列表

作業識別碼：: ChannelsGetPosts

獲取指定頻道內的帖子列表。

參數

名稱	機碼	必要	類型	Description
頻道ID	channelID	True	string	在此處插入通道 ID，例如由 getChannels 檢索。
限制	limit		integer	應傳回的專案數量（預設值和最多 100 個）。
Offset	offset		integer	定義偏移，以取得從此數字開始的項目。

傳回

名稱	路徑	類型	Description
總計	total	integer	找到的貼文總數。
limit	limit	integer	退回的項目數量。
位移	offset	integer	目前定義的偏移，用於取得從此數字開始的項目。
資料	data	array of postData

定義

媒體數據

名稱	路徑	類型	Description
識別碼	id	string	這是資產的 ID。
擁有者識別碼	ownerID	string	這是此資產擁有者的 ID。
家長標識碼	parentID	string	這是父媒體資產的ID。
公開標識碼	publicID	string	這是用於存取資產的公用 ID。
型別	resourceInfo.type	string	這是資產資源類型。
bytes	resourceInfo.bytes	integer	這是資源大小（以位元組為單位）。
寬度	resourceInfo.width	integer	這是資源寬度。
height	resourceInfo.height	integer	這是資源高度。
url	resourceInfo.url	string	這是資源 URL。
format	resourceInfo.format	string	這是資源格式。
mime類型	resourceInfo.mimeType	string	這是資源 MIME 類型。
fileName	fileName	string	這是媒體檔案名稱。
title	title	string	這是媒體標題。
標籤	label	string	這是媒體標籤。
創建	created	string	資產的建立日期。

用戶數據

名稱	路徑	類型	Description
識別碼	id	string	使用者的ID
外部識別碼	externalID	string	使用者的外部 ID
名字	firstName	string	使用者的名字
lastName	lastName	string	使用者的姓氏
publicEmail地址	publicEmailAddress	string	使用者的公開電子郵件
地區設定	config.locale	string	使用者的地區設定
電子郵件	emails	array of object	使用者電子郵件資訊
電子郵件	emails.value	string	電子郵件位址
主要	emails.primary	boolean	是主要電子郵件嗎？
群組 ID	groupIDs	array of string
位置	position	string	用戶的位置
部門	department	string	使用者的部門
位置	location	string	使用者的位置
電話號碼	phoneNumber	string	使用者的電話號碼
創建	created	string	使用者的建立日期
更新	updated	string	使用者的更新日期
已啟動	activated	string	使用者是否已啟用？

後數據

名稱	路徑	類型	Description
識別碼	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	這是專案的地區設定。
識別碼	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

名稱	路徑	類型	Description
名字	firstName	string	這是作者的名字。
識別碼	id	string	這是作者的ID。
lastName	lastName	string	這是作者的姓氏。
url	avatar.original.url	string	這是作者頭像圖片的原始網址。
寬度	avatar.original.width	integer	這是作者頭像圖片的原始寬度。
height	avatar.original.height	integer	這是作者頭像圖片的原始高度。
size	avatar.original.size	integer	這是作者頭像圖像原始sie（以字節為單位）。
format	avatar.original.format	string	這是作者頭像的原始格式。
mime類型	avatar.original.mimeType	string	這是 athor 頭像圖像原始 mimeType。
創建	avatar.original.created	string	這是作者頭像的原始創建日期。
url	avatar.icon.url	string	這是作者頭像圖示網址。
寬度	avatar.icon.width	integer	這是作者頭像圖示寬度。
height	avatar.icon.height	integer	這是作者頭像圖示高度。
format	avatar.icon.format	string	這是作者頭像圖示格式。
mime類型	avatar.icon.mimeType	string	這是作者頭像圖示mimeType。
url	avatar.thumb.url	string	這是作者頭像拇指網址。
寬度	avatar.thumb.width	integer	這是作者頭像拇指寬度。
height	avatar.thumb.height	integer	這是作者頭像拇指高度。
format	avatar.thumb.format	string	這是作者頭像拇指格式。
mime類型	avatar.thumb.mimeType	string	這是 athor avatar thumb mimeType。
公開標識碼	avatar.publicID	string	這是作者頭像公開ID。

imageObject

名稱	路徑	類型	Description
url	original.url	string	這是圖像原始網址。
寬度	original.width	integer	這是圖像原始寬度。
height	original.height	integer	這是圖像原始高度。
size	original.size	integer	這是圖像原始大小（以位元組為單位）。
format	original.format	string	這是圖像原始格式。
mime類型	original.mimeType	string	這是圖像原始 mimeType。
url	original_scaled.url	string	這是圖像原始網址。
寬度	original_scaled.width	integer	這是圖像原始寬度。
height	original_scaled.height	integer	這是圖像原始高度。
format	original_scaled.format	string	這是圖像原始格式。
mime類型	original_scaled.mimeType	string	這是圖像原始 mimeType。
url	compact.url	string	這是圖像精簡網址。
寬度	compact.width	integer	這是圖像緊湊的寬度。
height	compact.height	integer	這是圖像緊湊的高度。
format	compact.format	string	這是圖像緊湊格式。
mime類型	compact.mimeType	string	這是圖像緊湊的 mimeType。

共用方式為