Benifex (Preview)
Platforma Benifex zjednodušuje globální výhody zaměstnanců, pohodu a řízení odměn prostřednictvím jediného sjednoceného prostředí. Tento konektor umožňuje bezproblémovou integraci s platformou Benifex a poskytuje přístup k datům zaměstnanců, výběrům výhod a podrobnostem o způsobilosti.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Podpora pro Benifex |
| URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Benefex Ltd |
| Internetová stránka | https://benifex.com |
| Zásady ochrany osobních údajů | https://benifex.com/privacy-notice |
| Kategorie | Umělá inteligence; Personální |
Benifex Connector
Benifex se specializuje na poskytování technologií pro zkušenosti zaměstnanců a zaměřuje se na oblasti, jako jsou výhody, blaho, uznání a zapojení.
Pracujeme na tom, abychom vytvořili pozoruhodný zážitek, který zákazníci a zaměstnanci milují.
Konektor Benifex umožňuje integraci dat s platformou Benifex.
Vydavatel: Benifex
Požadavky
Začněte tím, že si zaregistrujete vývojářský účet pomocí svého Manažera úspěchu zákazníka Benifex. Po schválení se zobrazí odkaz na část správce našeho portálu pro vývojáře.
Budete také dodáváni s jedinečným zákazníkem client_id a secret. Jakmile budete mít tyto přihlašovací údaje, budete moct komunikovat s našimi rozhraními API.
Další podrobnosti najdete v průvodci ověřováním.
Podporované operace
- Získat uživatele: Načtěte ověřené informace o uživateli z platformy Benifex.
- Získat souhrnné výhody: Vrátí souhrn aktuálně dostupných výhod a výhod s nárokem na přidání pro ověřeného uživatele.
- Získat podrobné výhody: Vrátí podrobné informace o aktuálních výhodách a výhodách, které mají nárok na přidání pro ověřeného uživatele.
- Získání informací o výhodách uživatele: Vrátí informace o konkrétní výhodě ověřeného uživatele.
Další podrobnosti o těchto operacích najdete v referenční dokumentaci k rozhraní API.
Získání přihlašovacích údajů
Pokud chcete získat přístup k rozhraní API, budete muset získat potřebné přihlašovací údaje, jak je popsáno v části Požadavky .
Přístupový token JWT se získá pomocí toku přihlašovacích údajů klienta OAuth 2.0.
Získejte přístupový token JWT ověřením pomocí přihlašovacích údajů.
POSTOdešlete požadavek na identifikátor URI koncového bodu tokenu:
https://auth.onehub.dev/auth/realms/default/protocol/openid-connect/tokenPřidejte hlavičku nastavenou
Content-Typenaapplication/x-www-form-urlencodedhodnotu .Do textu HTTP uveďte následující:
client_idclient_secretgrant_type=client_credentials
Začínáme
Úplnou dokumentaci, průvodce implementací a testování sandboxu najdete na portálu rozhraní API Benifex.
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Získání informací o uživateli |
Získejte informace o uživateli ověřeného uživatele. |
| Získání informací o výhodách uživatelů |
Vrátí podrobnosti o jedné výhodě ověřeného uživatele. |
| Získání podrobných dostupných a výhod s nárokem na přidání uživatele |
Vrátí podrobnosti o aktuálním uživateli, který má nárok na přidání výhod pro ověřeného uživatele. |
| Získání souhrnných dostupných a způsobilých výhod pro přidání uživatele |
Vrátí aktuální hodnotu a nárok na přidání výhod pro ověřeného uživatele. |
Získání informací o uživateli
Získejte informace o uživateli ověřeného uživatele.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečné ID požadavku
|
X-Client-Request-Id | string |
ID, které jednoznačně identifikuje požadavek. Pokud přidáte, pomůže vám to jakékoli ladění požadavků a dá se použít k kontrolám idempotenci. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
data.id | string |
identifikační číslo |
|
křestní jméno
|
data.forename | string |
křestní jméno |
|
příjmení
|
data.surname | string |
příjmení |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
telefonní číslo
|
data.phoneNumber | string |
telefonní číslo |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
řádek 3
|
data.address.line3 | string |
řádek 3 |
|
řádek 4
|
data.address.line4 | string |
řádek 4 |
|
řádek 5
|
data.address.line5 | string |
řádek 5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
země
|
data.address.country | string |
země |
|
e-mailová adresa
|
data.emailAddress | string |
e-mailová adresa |
|
gender
|
data.gender | string |
gender |
|
národnost
|
data.nationality | string |
národnost |
|
jazyk
|
data.language | string |
jazyk |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
ID zaměstnance
|
data.employment.employeeId | string |
ID zaměstnance |
|
additionalEmployeeId
|
data.employment.additionalEmployeeId | string |
additionalEmployeeId |
|
startDate
|
data.employment.startDate | date |
startDate |
|
originalStartDate
|
data.employment.originalStartDate | date |
originalStartDate |
|
probationPassedDate
|
data.employment.probationPassedDate | date |
probationPassedDate |
|
apprenticeStartDate
|
data.employment.apprenticeStartDate | date |
apprenticeStartDate |
|
název pracovní pozice
|
data.employment.jobTitle | string |
název pracovní pozice |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
třída
|
data.employment.grade | string |
třída |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
oddělení
|
data.employment.department | string |
oddělení |
|
dělení
|
data.employment.division | string |
dělení |
|
businessUnit
|
data.employment.businessUnit | string |
businessUnit |
|
poloha
|
data.employment.location | string |
poloha |
|
countryOfWork
|
data.employment.countryOfWork | string |
countryOfWork |
|
globalTransferDate
|
data.employment.globalTransferDate | date |
globalTransferDate |
|
costCentre
|
data.employment.costCentre | string |
costCentre |
|
workPostCode
|
data.employment.workPostCode | string |
workPostCode |
|
workPhoneNumber
|
data.employment.workPhoneNumber | string |
workPhoneNumber |
|
contractedHours
|
data.employment.workingHours.contractedHours | double |
contractedHours |
|
fullTimeEquivalentHours
|
data.employment.workingHours.fullTimeEquivalentHours | double |
fullTimeEquivalentHours |
|
daysPerWeek
|
data.employment.workingHours.daysPerWeek | integer |
daysPerWeek |
|
fullTimeEquivalentFraction
|
data.employment.workingHours.fullTimeEquivalentFraction | double |
fullTimeEquivalentFraction |
|
holidayDays
|
data.employment.workingHours.holidayDays | double |
holidayDays |
|
holidayHours
|
data.employment.workingHours.holidayHours | integer |
holidayHours |
|
startDate
|
data.employment.contractDetails.startDate | date |
startDate |
|
datum ukončení
|
data.employment.contractDetails.endDate | date |
datum ukončení |
|
typ
|
data.employment.contractDetails.type | string |
typ |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
plat
|
data.employment.salaryDetails.salary | double |
plat |
|
platEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | date |
platEffectiveDate |
|
pensionableSalary
|
data.employment.salaryDetails.pensionableSalary | double |
pensionableSalary |
|
payPeriods
|
data.employment.salaryDetails.payPeriods | integer |
payPeriods |
|
marketCarAllowance
|
data.employment.salaryDetails.marketCarAllowance | double |
marketCarAllowance |
|
flexFund
|
data.employment.funding.flexFund | double |
flexFund |
|
financeLevel1
|
data.employment.funding.fundingLevel1 | string |
financeLevel1 |
|
financeLevel2
|
data.employment.funding.fundingLevel2 | string |
financeLevel2 |
|
financeLevel3
|
data.employment.funding.fundingLevel3 | string |
financeLevel3 |
|
financeLevel4
|
data.employment.funding.fundingLevel4 | string |
financeLevel4 |
|
financeLevel5
|
data.employment.funding.fundingLevel5 | string |
financeLevel5 |
|
leaveDate
|
data.employment.leaveDate | date |
leaveDate |
|
ukončeníreason
|
data.employment.terminationReason | string |
ukončeníreason |
|
isLeaver
|
data.employment.isLeaver | boolean |
isLeaver |
|
nationalIdentityNumber1
|
data.nationalIdentity.nationalIdentityNumber1 | string |
nationalIdentityNumber1 |
|
nationalIdentityNumber2
|
data.nationalIdentity.nationalIdentityNumber2 | string |
nationalIdentityNumber2 |
|
nationalIdentityNumber3
|
data.nationalIdentity.nationalIdentityNumber3 | string |
nationalIdentityNumber3 |
|
nationalIdentityCountry
|
data.nationalIdentity.nationalIdentityCountry | string |
nationalIdentityCountry |
|
lastBenefitsLoginTimestamp
|
data.lastBenefitsLoginTimestamp | string |
lastBenefitsLoginTimestamp |
|
customAttributes
|
data.customAttributes | object |
customAttributes |
|
časové razítko
|
timestamp | date-time |
časové razítko |
Získání informací o výhodách uživatelů
Vrátí podrobnosti o jedné výhodě ověřeného uživatele.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečné ID požadavku
|
X-Client-Request-Id | string |
ID, které jednoznačně identifikuje požadavek. Pokud přidáte, pomůže vám to jakékoli ladění požadavků a dá se použít k kontrolám idempotenci. |
|
|
Jedinečný identifikátor výhody
|
benefit-key | True | string |
Konkrétní klíč použitý k identifikaci informací o výhodách, které chcete pro daného uživatele načíst |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
stav
|
data.status | string |
stav |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
roční
|
data.benefitCost.annual | double |
roční |
|
měsíčně
|
data.benefitCost.monthly | double |
měsíčně |
|
měna
|
data.benefitCost.currency | string |
měna |
|
roční
|
data.employeeContribution.annual | double |
roční |
|
měsíčně
|
data.employeeContribution.monthly | double |
měsíčně |
|
měna
|
data.employeeContribution.currency | string |
měna |
|
roční
|
data.employerContribution.annual | double |
roční |
|
měsíčně
|
data.employerContribution.monthly | double |
měsíčně |
|
měna
|
data.employerContribution.currency | string |
měna |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
popis
|
data.description | string |
popis |
|
sekce
|
data.sections | array of object |
sekce |
|
title
|
data.sections.title | string |
title |
|
typ
|
data.sections.type | string |
typ |
|
obsah
|
data.sections.content | string |
obsah |
|
sekce
|
data.sections.sections | array of object |
sekce |
|
title
|
data.sections.sections.title | string |
title |
|
typ
|
data.sections.sections.type | string |
typ |
|
obsah
|
data.sections.sections.content | string |
obsah |
|
Nejčastější dotazy
|
data.faqs | array of object |
Nejčastější dotazy |
|
otázka
|
data.faqs.question | string |
otázka |
|
odpověď
|
data.faqs.answer | string |
odpověď |
|
needToKnow
|
data.needToKnow | string |
needToKnow |
|
užitečné Odkazy
|
data.usefulLinks | array of object |
užitečné Odkazy |
|
URI
|
data.usefulLinks.uri | string |
URI |
|
linkText
|
data.usefulLinks.linkText | string |
linkText |
|
datesFormat
|
data.datesFormat | string |
datesFormat |
|
časové razítko
|
timestamp | date-time |
časové razítko |
Získání podrobných dostupných a výhod s nárokem na přidání uživatele
Vrátí podrobnosti o aktuálním uživateli, který má nárok na přidání výhod pro ověřeného uživatele.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečné ID požadavku
|
X-Client-Request-Id | string |
ID, které jednoznačně identifikuje požadavek. Pokud přidáte, pomůže vám to jakékoli ladění požadavků a dá se použít k kontrolám idempotenci. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
stav
|
data.currentBenefits.status | string |
stav |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
roční
|
data.currentBenefits.benefitCost.annual | double |
roční |
|
měsíčně
|
data.currentBenefits.benefitCost.monthly | double |
měsíčně |
|
měna
|
data.currentBenefits.benefitCost.currency | string |
měna |
|
roční
|
data.currentBenefits.employeeContribution.annual | double |
roční |
|
měsíčně
|
data.currentBenefits.employeeContribution.monthly | double |
měsíčně |
|
měna
|
data.currentBenefits.employeeContribution.currency | string |
měna |
|
roční
|
data.currentBenefits.employerContribution.annual | double |
roční |
|
měsíčně
|
data.currentBenefits.employerContribution.monthly | double |
měsíčně |
|
měna
|
data.currentBenefits.employerContribution.currency | string |
měna |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
popis
|
data.currentBenefits.description | string |
popis |
|
sekce
|
data.currentBenefits.sections | array of object |
sekce |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
typ
|
data.currentBenefits.sections.type | string |
typ |
|
obsah
|
data.currentBenefits.sections.content | string |
obsah |
|
sekce
|
data.currentBenefits.sections.sections | array of object |
sekce |
|
title
|
data.currentBenefits.sections.sections.title | string |
title |
|
typ
|
data.currentBenefits.sections.sections.type | string |
typ |
|
obsah
|
data.currentBenefits.sections.sections.content | string |
obsah |
|
Nejčastější dotazy
|
data.currentBenefits.faqs | array of object |
Nejčastější dotazy |
|
otázka
|
data.currentBenefits.faqs.question | string |
otázka |
|
odpověď
|
data.currentBenefits.faqs.answer | string |
odpověď |
|
needToKnow
|
data.currentBenefits.needToKnow | string |
needToKnow |
|
užitečné Odkazy
|
data.currentBenefits.usefulLinks | array of object |
užitečné Odkazy |
|
URI
|
data.currentBenefits.usefulLinks.uri | string |
URI |
|
linkText
|
data.currentBenefits.usefulLinks.linkText | string |
linkText |
|
datesFormat
|
data.currentBenefits.datesFormat | string |
datesFormat |
|
eligibleToAddBenefits
|
data.eligibleToAddBenefits | array of object |
eligibleToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
popis
|
data.eligibleToAddBenefits.description | string |
popis |
|
sekce
|
data.eligibleToAddBenefits.sections | array of object |
sekce |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
typ
|
data.eligibleToAddBenefits.sections.type | string |
typ |
|
obsah
|
data.eligibleToAddBenefits.sections.content | string |
obsah |
|
sekce
|
data.eligibleToAddBenefits.sections.sections | array of object |
sekce |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
typ
|
data.eligibleToAddBenefits.sections.sections.type | string |
typ |
|
obsah
|
data.eligibleToAddBenefits.sections.sections.content | string |
obsah |
|
sekce
|
data.eligibleToAddBenefits.sections.sections.sections | array of object |
sekce |
|
title
|
data.eligibleToAddBenefits.sections.sections.sections.title | string |
title |
|
typ
|
data.eligibleToAddBenefits.sections.sections.sections.type | string |
typ |
|
obsah
|
data.eligibleToAddBenefits.sections.sections.sections.content | string |
obsah |
|
Nejčastější dotazy
|
data.eligibleToAddBenefits.faqs | array of object |
Nejčastější dotazy |
|
otázka
|
data.eligibleToAddBenefits.faqs.question | string |
otázka |
|
odpověď
|
data.eligibleToAddBenefits.faqs.answer | string |
odpověď |
|
needToKnow
|
data.eligibleToAddBenefits.needToKnow | string |
needToKnow |
|
užitečné Odkazy
|
data.eligibleToAddBenefits.usefulLinks | array of object |
užitečné Odkazy |
|
URI
|
data.eligibleToAddBenefits.usefulLinks.uri | string |
URI |
|
linkText
|
data.eligibleToAddBenefits.usefulLinks.linkText | string |
linkText |
|
datesFormat
|
data.eligibleToAddBenefits.datesFormat | string |
datesFormat |
|
časové razítko
|
timestamp | date-time |
časové razítko |
Získání souhrnných dostupných a způsobilých výhod pro přidání uživatele
Vrátí aktuální hodnotu a nárok na přidání výhod pro ověřeného uživatele.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečné ID požadavku
|
X-Client-Request-Id | string |
ID, které jednoznačně identifikuje požadavek. Pokud přidáte, pomůže vám to jakékoli ladění požadavků a dá se použít k kontrolám idempotenci. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
stav
|
data.currentBenefits.status | string |
stav |
|
eligibleToAddBenefits
|
data.eligibleToAddBenefits | array of object |
eligibleToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
stav
|
data.eligibleToAddBenefits.status | string |
stav |
|
časové razítko
|
timestamp | date-time |
časové razítko |