Benifex （預覽版）

Benifex 平台透過單一、統一的體驗簡化了全球員工福利、福祉和獎勵管理。此連接器可與 Benifex 平台無縫集成，提供對員工資料、福利選擇和資格詳細資訊的存取

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

服務	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）

連絡人
名稱	Benifex 支持
URL	https://benifex.com/contact-us
Email	et-noreply@benifex.com

連接器中繼資料
Publisher	貝內菲克斯有限公司
網站	https://benifex.com
隱私策略	https://benifex.com/privacy-notice
類別	人工智慧;人力資源

Benifex 連接器

Benifex 專注於提供員工體驗技術，專注於福利、福祉、認可和敬業度等領域。
我們的使命是打造客戶和員工喜愛的卓越體驗。
Benifex 連接器可與 Benifex 平台進行資料整合。

發行商：貝尼菲克斯

先決條件

首先，請向您的 Benifex 客戶成功經理註冊一個開發人員帳戶。一旦獲得批准，您將獲得我們開發人員入口網站管理部分的連結。
您還將獲得您的獨特客戶 client_id 和 secret。獲得這些憑證後，您將能夠與我們的 API 進行通訊。
如需詳細資訊，請參閱驗證指南。

支援的作業

獲取現有用戶：通過員工 ID 檢索現有用戶。支持分頁。
獲取現有用戶：從 Benifex 平台檢索特定用戶。
取得摘要權益：傳回指定使用者目前可用且符合資格新增權益的摘要。
獲取詳細福利：返回有關給定用戶當前和符合資格添加福利的詳細信息。
取得使用者權益資訊：傳回特定使用者特定權益的相關資訊。

如需這些作業的詳細資訊，請參閱 API參考檔案。

取得憑證

若要存取我們的API，您必須取得必要的認證，如 先決條件 一節所述。
JWT 存取權杖是使用 OAuth 2.0 用戶端認證流程取得。
使用您的認證進行驗證，以取得您的 JWT 存取權杖。

將要求傳送 POST 至權杖端點 URI：
https://hub.onehub.global/oauth2/default/v1/token
將標頭集Content-Type新增至 application/x-www-form-urlencoded 。
在 HTTP 內文中包含下列項目：
- client_id
- client_secret
- grant_type=client_credentials

使用者入門

如需完整文件、實作指南和沙箱測試，請造訪 Benifex API 入口網站。

節流限制

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

動作

取得使用者權益資訊	傳回所要求使用者的單一權益詳細資料
取得現有使用者	在 Benifex 平台上創建用戶
獲取現有用戶	通過員工 ID 在 Benifex 平台上創建用戶，並支持分頁
獲取用戶的摘要可用和有資格添加的好處	傳回目前且符合資格，為所要求的使用者新增權益
獲取用戶的詳細可用和有資格添加的好處	傳回目前且有資格為所要求使用者新增權益的詳細資料

取得使用者權益資訊

作業識別碼：: GetUserBenefitInformation

傳回所要求使用者的單一權益詳細資料

參數

名稱	機碼	必要	類型	Description
使用者的唯一 ID	user-id	True	string	您要取得相關資訊之使用者的特定 ID
唯一權益識別碼	benefit-key	True	string	用於識別您要為指定使用者擷取哪些福利資訊的特定金鑰

傳回

名稱	路徑	類型	Description
狀態	data.status	string	狀態
effectiveFrom	data.effectiveFrom	string	effectiveFrom
可編輯直到	data.editableUntil	string	可編輯直到
變更日期	data.changeDate	string	變更日期
每年的	data.benefitCost.annual	double	每年的
按月	data.benefitCost.monthly	double	按月
貨幣	data.benefitCost.currency	string	貨幣
每年的	data.employeeContribution.annual	double	每年的
按月	data.employeeContribution.monthly	double	按月
貨幣	data.employeeContribution.currency	string	貨幣
每年的	data.employerContribution.annual	double	每年的
按月	data.employerContribution.monthly	double	按月
貨幣	data.employerContribution.currency	string	貨幣
benefitKey	data.benefitKey	string	benefitKey
title	data.title	string	title
benefitLink	data.benefitLink	string	benefitLink
說明	data.description	string	說明
部分	data.sections	array of object	部分
title	data.sections.title	string	title
型別	data.sections.type	string	型別
內容	data.sections.content	string	內容
部分	data.sections.sections	array of object	部分
title	data.sections.sections.title	string	title
型別	data.sections.sections.type	string	型別
內容	data.sections.sections.content	string	內容
常見問題	data.faqs	array of object	常見問題
鞫	data.faqs.question	string	鞫
答	data.faqs.answer	string	答
需要知道	data.needToKnow	string	需要知道
有用的鏈接	data.usefulLinks	array of object	有用的鏈接
統一資源識別碼 (URI)	data.usefulLinks.uri	string	統一資源識別碼 (URI)
連結文字	data.usefulLinks.linkText	string	連結文字
日期格式	data.datesFormat	string	日期格式
時間戳記	timestamp	date-time	時間戳記

取得現有使用者

作業識別碼：: GetExistingUser

在 Benifex 平台上創建用戶

參數

名稱	機碼	必要	類型	Description
使用者的唯一 ID	user-id	True	string	您要取得相關資訊之使用者的特定 ID

傳回

名稱	路徑	類型	Description
識別碼	data.id	string	識別碼
名字	data.forename	string	名字
姓	data.surname	string	姓
dateOfBirth	data.dateOfBirth	date	dateOfBirth
title	data.title	string	title
preferredName	data.preferredName	string	preferredName
localName	data.localName	string	localName
電話號碼	data.phoneNumber	string	電話號碼
line1	data.address.line1	string	line1
line2	data.address.line2	string	line2
行3	data.address.line3	string	行3
第4行	data.address.line4	string	第4行
第5行	data.address.line5	string	第5行
郵遞區號郵遞區號	data.address.postcodeZipCode	string	郵遞區號郵遞區號
country	data.address.country	string	country
電子郵件地址	data.emailAddress	string	電子郵件地址
性	data.gender	string	性
民族	data.nationality	string	民族
語言	data.language	string	語言
婚姻狀況	data.maritalStatus	string	婚姻狀況
有效婚姻狀況日期	data.effectiveDateOfMaritalStatus	date	有效婚姻狀況日期
員工編號	data.employment.employeeId	string	員工編號
附加員工識別碼	data.employment.additionalEmployeeId	string	附加員工識別碼
startDate	data.employment.startDate	date	startDate
originalStartDate	data.employment.originalStartDate	date	originalStartDate
試用通過日期	data.employment.probationPassedDate	date	試用通過日期
學徒開始日期	data.employment.apprenticeStartDate	date	學徒開始日期
leaveDate	data.employment.leaveDate	date	leaveDate
終止原因	data.employment.terminationReason	string	終止原因
職位名稱	data.employment.jobTitle	string	職位名稱
就業狀態	data.employment.employmentStatus	string	就業狀態
級	data.employment.grade	string	級
法律雇主公司	data.employment.legalEmployerCompany	string	法律雇主公司
部門	data.employment.department	string	部門
師	data.employment.division	string	師
業務單位	data.employment.businessUnit	string	業務單位
位置	data.employment.location	string	位置
工作國家	data.employment.countryOfWork	string	工作國家
globalTransferDate	data.employment.globalTransferDate	date	globalTransferDate
成本中心	data.employment.costCentre	string	成本中心
工作郵遞區號	data.employment.workPostCode	string	工作郵遞區號
工作電話號碼	data.employment.workPhoneNumber	string	工作電話號碼
合約時數	data.employment.workingHours.contractedHours	double	合約時數
全職等效小時數	data.employment.workingHours.fullTimeEquivalentHours	double	全職等效小時數
每週天數	data.employment.workingHours.daysPerWeek	integer	每週天數
fullTimeEquivalentFraction	data.employment.workingHours.fullTimeEquivalentFraction	double	fullTimeEquivalentFraction
假期天數	data.employment.workingHours.holidayDays	double	假期天數
假日營業時間	data.employment.workingHours.holidayHours	integer	假日營業時間
支付組	data.employment.salaryDetails.payGroup	string	支付組
薪水	data.employment.salaryDetails.salary	double	薪水
薪資生效日期	data.employment.salaryDetails.salaryEffectiveDate	date	薪資生效日期
應領取退休金薪資	data.employment.salaryDetails.pensionableSalary	double	應領取退休金薪資
付款期間	data.employment.salaryDetails.payPeriods	integer	付款期間
市場汽車津貼	data.employment.salaryDetails.marketCarAllowance	double	市場汽車津貼
彈性基金	data.employment.funding.flexFund	double	彈性基金
資金級別1	data.employment.funding.fundingLevel1	string	資金級別1
資金級別2	data.employment.funding.fundingLevel2	string	資金級別2
資金級別3	data.employment.funding.fundingLevel3	string	資金級別3
資金級別4	data.employment.funding.fundingLevel4	string	資金級別4
資金等級5	data.employment.funding.fundingLevel5	string	資金等級5
startDate	data.employment.contractDetails.startDate	date	startDate
結束日期	data.employment.contractDetails.endDate	date	結束日期
型別	data.employment.contractDetails.type	string	型別
國家身分識別號碼1	data.nationalIdentity.nationalIdentityNumber1	string	國家身分識別號碼1
國民身分證號碼2	data.nationalIdentity.nationalIdentityNumber2	string	國民身分證號碼2
國民身分證號碼3	data.nationalIdentity.nationalIdentityNumber3	string	國民身分證號碼3
nationalIdentityCountry	data.nationalIdentity.nationalIdentityCountry	string	nationalIdentityCountry
自訂屬性	data.customAttributes	object	自訂屬性
時間戳記	timestamp	date-time	時間戳記

獲取現有用戶

作業識別碼：: GetExistingUsers

通過員工 ID 在 Benifex 平台上創建用戶，並支持分頁

參數

名稱	機碼	必要	類型	Description
要擷取的員工 ID	employeeIds	True	string	用於過濾從 Benifex 平台獲取的用戶的唯一員工標識符

傳回

名稱	路徑	類型	Description
頁面	pagination.page	integer	頁面
size	pagination.size	integer	size
總頁數	pagination.totalPages	integer	總頁數
totalItems	pagination.totalItems	integer	totalItems
有下一個	pagination.hasNext	boolean	有下一個
有上一頁	pagination.hasPrevious	boolean	有上一頁
資料	data	array of object	資料
識別碼	data.id	string	識別碼
電子郵件地址	data.emailAddress	string	電子郵件地址
名字	data.forename	string	名字
姓	data.surname	string	姓
員工編號	data.employeeId	string	員工編號
部門	data.department	string	部門
職位名稱	data.jobTitle	string	職位名稱
位置	data.location	string	位置
工作國家	data.countryOfWork	string	工作國家
dateOfBirth	data.dateOfBirth	date	dateOfBirth
startDate	data.startDate	date	startDate
業務單位	data.businessUnit	string	業務單位
性	data.gender	string	性
時間戳記	timestamp	date-time	時間戳記

獲取用戶的摘要可用和有資格添加的好處

作業識別碼：: GetSummarizedAvailableAndEligibleToAddBenefitsOfUser

傳回目前且符合資格，為所要求的使用者新增權益

參數

名稱	機碼	必要	類型	Description
使用者的唯一 ID	user-id	True	string	您要取得相關資訊之使用者的特定 ID
回應格式	accept		string	定義回應中預期的媒體類型，通常設定為 application/json 以接收 JSON 格式的資料

傳回

名稱	路徑	類型	Description
當前福利	data.currentBenefits	array of object	當前福利
benefitKey	data.currentBenefits.benefitKey	string	benefitKey
title	data.currentBenefits.title	string	title
benefitLink	data.currentBenefits.benefitLink	string	benefitLink
狀態	data.currentBenefits.status	string	狀態
eligibleToAdd福利	data.eligibleToAddBenefits	array of object	eligibleToAdd福利
benefitKey	data.eligibleToAddBenefits.benefitKey	string	benefitKey
title	data.eligibleToAddBenefits.title	string	title
benefitLink	data.eligibleToAddBenefits.benefitLink	string	benefitLink
狀態	data.eligibleToAddBenefits.status	string	狀態
時間戳記	timestamp	date-time	時間戳記

獲取用戶的詳細可用和有資格添加的好處

作業識別碼：: GetDetailedAvailableAndEligibleToAddBenefitsOfUser

傳回目前且有資格為所要求使用者新增權益的詳細資料

參數

名稱	機碼	必要	類型	Description
使用者的唯一 ID	user-id	True	string	您要取得相關資訊之使用者的特定 ID
回應格式	accept		string	定義回應中預期的媒體類型，通常設定為 application/json 以接收 JSON 格式的資料

傳回

名稱	路徑	類型	Description
當前福利	data.currentBenefits	array of object	當前福利
狀態	data.currentBenefits.status	string	狀態
effectiveFrom	data.currentBenefits.effectiveFrom	string	effectiveFrom
可編輯直到	data.currentBenefits.editableUntil	string	可編輯直到
變更日期	data.currentBenefits.changeDate	string	變更日期
每年的	data.currentBenefits.benefitCost.annual	double	每年的
按月	data.currentBenefits.benefitCost.monthly	double	按月
貨幣	data.currentBenefits.benefitCost.currency	string	貨幣
每年的	data.currentBenefits.employeeContribution.annual	double	每年的
按月	data.currentBenefits.employeeContribution.monthly	double	按月
貨幣	data.currentBenefits.employeeContribution.currency	string	貨幣
每年的	data.currentBenefits.employerContribution.annual	double	每年的
按月	data.currentBenefits.employerContribution.monthly	double	按月
貨幣	data.currentBenefits.employerContribution.currency	string	貨幣
benefitKey	data.currentBenefits.benefitKey	string	benefitKey
title	data.currentBenefits.title	string	title
benefitLink	data.currentBenefits.benefitLink	string	benefitLink
說明	data.currentBenefits.description	string	說明
部分	data.currentBenefits.sections	array of object	部分
title	data.currentBenefits.sections.title	string	title
型別	data.currentBenefits.sections.type	string	型別
內容	data.currentBenefits.sections.content	string	內容
部分	data.currentBenefits.sections.sections	array of	部分
常見問題	data.currentBenefits.faqs	array of object	常見問題
鞫	data.currentBenefits.faqs.question	string	鞫
答	data.currentBenefits.faqs.answer	string	答
需要知道	data.currentBenefits.needToKnow	string	需要知道
有用的鏈接	data.currentBenefits.usefulLinks	array of object	有用的鏈接
統一資源識別碼 (URI)	data.currentBenefits.usefulLinks.uri	string	統一資源識別碼 (URI)
連結文字	data.currentBenefits.usefulLinks.linkText	string	連結文字
日期格式	data.currentBenefits.datesFormat	string	日期格式
eligibleToAdd福利	data.eligibleToAddBenefits	array of object	eligibleToAdd福利
benefitKey	data.eligibleToAddBenefits.benefitKey	string	benefitKey
title	data.eligibleToAddBenefits.title	string	title
benefitLink	data.eligibleToAddBenefits.benefitLink	string	benefitLink
說明	data.eligibleToAddBenefits.description	string	說明
部分	data.eligibleToAddBenefits.sections	array of object	部分
title	data.eligibleToAddBenefits.sections.title	string	title
型別	data.eligibleToAddBenefits.sections.type	string	型別
內容	data.eligibleToAddBenefits.sections.content	string	內容
部分	data.eligibleToAddBenefits.sections.sections	array of object	部分
title	data.eligibleToAddBenefits.sections.sections.title	string	title
型別	data.eligibleToAddBenefits.sections.sections.type	string	型別
內容	data.eligibleToAddBenefits.sections.sections.content	string	內容
常見問題	data.eligibleToAddBenefits.faqs	array of object	常見問題
鞫	data.eligibleToAddBenefits.faqs.question	string	鞫
答	data.eligibleToAddBenefits.faqs.answer	string	答
需要知道	data.eligibleToAddBenefits.needToKnow	string	需要知道
有用的鏈接	data.eligibleToAddBenefits.usefulLinks	array of object	有用的鏈接
統一資源識別碼 (URI)	data.eligibleToAddBenefits.usefulLinks.uri	string	統一資源識別碼 (URI)
連結文字	data.eligibleToAddBenefits.usefulLinks.linkText	string	連結文字
日期格式	data.eligibleToAddBenefits.datesFormat	string	日期格式
時間戳記	timestamp	date-time	時間戳記

共用方式為