Benifex (Vorschau)
Die Benifex-Plattform vereinfacht globale Mitarbeitervorteile, Wohlbefinden und Belohnungsmanagement durch eine einzige, einheitliche Erfahrung. Dieser Connector ermöglicht eine nahtlose Integration mit der Benifex-Plattform, bietet Zugriff auf Mitarbeiterdaten, Vorteilsauswahlen und Berechtigungsdetails.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Benifex-Support |
| URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Benefex Ltd |
| Webseite | https://benifex.com |
| Datenschutzrichtlinie | https://benifex.com/privacy-notice |
| Kategorien | Künstliche Intelligenz; Personalabteilung |
Benifex Connector
Benifex ist auf die Bereitstellung von Technologie für Mitarbeitererfahrung spezialisiert, die sich auf Bereiche wie Vorteile, Wohlbefinden, Anerkennung und Engagement konzentriert.
Wir sind auf der Mission, bemerkenswerte Erfahrungen zu schaffen, die Kunden und Mitarbeiter lieben.
Der Benifex-Connector ermöglicht die Datenintegration mit der Benifex-Plattform.
Herausgeber: Benifex
Voraussetzungen
Registrieren Sie sich für ein Entwicklerkonto mit Ihrem Benifex Customer Success Manager. Nach der Genehmigung erhalten Sie einen Link zum Administratorabschnitt unseres Entwicklerportals.
Sie werden auch mit Ihrem einzigartigen Kunden client_id und secret. Sobald Sie über diese Anmeldeinformationen verfügen, können Sie mit unseren APIs kommunizieren.
Weitere Informationen finden Sie im Authentifizierungshandbuch.
Unterstützte Vorgänge
- Abrufen von Benutzer: Abrufen der authentifizierten Benutzerinformationen von der Benifex-Plattform.
- Zusammenfassung der Vorteile: Gibt eine Zusammenfassung der derzeit verfügbaren und berechtigten Vorteile für den authentifizierten Benutzer zurück.
- Detaillierte Vorteile erhalten: Gibt detaillierte Informationen zu aktuellen und berechtigten Vorteilen für den authentifizierten Benutzer zurück.
- Abrufen von Benutzervorteilsinformationen: Gibt Informationen zu einem bestimmten Vorteil für den authentifizierten Benutzer zurück.
Weitere Informationen zu diesen Vorgängen finden Sie in der API-Referenzdokumentation.
Abrufen von Anmeldeinformationen
Um auf unsere API zuzugreifen, müssen Sie die erforderlichen Anmeldeinformationen abrufen, wie im Abschnitt "Voraussetzungen" beschrieben.
Ein JWT-Zugriffstoken wird mithilfe des OAuth 2.0-Clientanmeldeinformationsflusses abgerufen.
Rufen Sie Ihr JWT-Zugriffstoken ab, indem Sie sich mit Ihren Anmeldeinformationen authentifizieren.
Senden einer
POSTAnforderung an den Tokenendpunkt-URI:
https://auth.onehub.dev/auth/realms/default/protocol/openid-connect/tokenFügen Sie den
Content-TypeKopfzeilensatz hinzu.application/x-www-form-urlencodedFügen Sie Folgendes in den HTTP-Textkörper ein:
client_idclient_secretgrant_type=client_credentials
Erste Schritte
Eine vollständige Dokumentation, Implementierungshandbücher und Sandkastentests finden Sie im Benifex-API-Portal.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen detaillierter verfügbarer und berechtigter Vorteile des Benutzers |
Gibt Details zu aktuellen und berechtigten Vorteilen für den authentifizierten Benutzer zurück. |
| Abrufen von Benutzerinformationen |
Abrufen von Benutzerinformationen für den authentifizierten Benutzer. |
| Abrufen von Benutzervorteilsinformationen |
Gibt Details des einzelnen Vorteils des authentifizierten Benutzers zurück. |
| Zusammenfassung der verfügbaren und berechtigten Vorteile des Benutzers |
Gibt aktuelle und berechtigte Vorteile für den authentifizierten Benutzer zurück. |
Abrufen detaillierter verfügbarer und berechtigter Vorteile des Benutzers
Gibt Details zu aktuellen und berechtigten Vorteilen für den authentifizierten Benutzer zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige Anforderungs-ID
|
X-Client-Request-Id | string |
Eine ID, die die Anforderung eindeutig identifiziert. Wenn hinzugefügt, unterstützt dies jedes Anforderungsdebugging und kann für idempotente Prüfungen verwendet werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
status
|
data.currentBenefits.status | string |
status |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
jährlich
|
data.currentBenefits.benefitCost.annual | double |
jährlich |
|
monatlich
|
data.currentBenefits.benefitCost.monthly | double |
monatlich |
|
currency
|
data.currentBenefits.benefitCost.currency | string |
currency |
|
jährlich
|
data.currentBenefits.employeeContribution.annual | double |
jährlich |
|
monatlich
|
data.currentBenefits.employeeContribution.monthly | double |
monatlich |
|
currency
|
data.currentBenefits.employeeContribution.currency | string |
currency |
|
jährlich
|
data.currentBenefits.employerContribution.annual | double |
jährlich |
|
monatlich
|
data.currentBenefits.employerContribution.monthly | double |
monatlich |
|
currency
|
data.currentBenefits.employerContribution.currency | string |
currency |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
Beschreibung
|
data.currentBenefits.description | string |
Beschreibung |
|
Abschnitte
|
data.currentBenefits.sections | array of object |
Abschnitte |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
Inhalt
|
data.currentBenefits.sections.content | string |
Inhalt |
|
Abschnitte
|
data.currentBenefits.sections.sections | array of object |
Abschnitte |
|
title
|
data.currentBenefits.sections.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.sections.type | string |
type |
|
Inhalt
|
data.currentBenefits.sections.sections.content | string |
Inhalt |
|
Häufig gestellte Fragen
|
data.currentBenefits.faqs | array of object |
Häufig gestellte Fragen |
|
Frage
|
data.currentBenefits.faqs.question | string |
Frage |
|
Antwort
|
data.currentBenefits.faqs.answer | string |
Antwort |
|
needToKnow
|
data.currentBenefits.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.currentBenefits.usefulLinks | array of object |
usefulLinks |
|
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 |
|
Beschreibung
|
data.eligibleToAddBenefits.description | string |
Beschreibung |
|
Abschnitte
|
data.eligibleToAddBenefits.sections | array of object |
Abschnitte |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
Inhalt
|
data.eligibleToAddBenefits.sections.content | string |
Inhalt |
|
Abschnitte
|
data.eligibleToAddBenefits.sections.sections | array of object |
Abschnitte |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.type | string |
type |
|
Inhalt
|
data.eligibleToAddBenefits.sections.sections.content | string |
Inhalt |
|
Abschnitte
|
data.eligibleToAddBenefits.sections.sections.sections | array of object |
Abschnitte |
|
title
|
data.eligibleToAddBenefits.sections.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.sections.type | string |
type |
|
Inhalt
|
data.eligibleToAddBenefits.sections.sections.sections.content | string |
Inhalt |
|
Häufig gestellte Fragen
|
data.eligibleToAddBenefits.faqs | array of object |
Häufig gestellte Fragen |
|
Frage
|
data.eligibleToAddBenefits.faqs.question | string |
Frage |
|
Antwort
|
data.eligibleToAddBenefits.faqs.answer | string |
Antwort |
|
needToKnow
|
data.eligibleToAddBenefits.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.eligibleToAddBenefits.usefulLinks | array of object |
usefulLinks |
|
URI
|
data.eligibleToAddBenefits.usefulLinks.uri | string |
URI |
|
linkText
|
data.eligibleToAddBenefits.usefulLinks.linkText | string |
linkText |
|
datesFormat
|
data.eligibleToAddBenefits.datesFormat | string |
datesFormat |
|
Zeitstempel
|
timestamp | date-time |
Zeitstempel |
Abrufen von Benutzerinformationen
Abrufen von Benutzerinformationen für den authentifizierten Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige Anforderungs-ID
|
X-Client-Request-Id | string |
Eine ID, die die Anforderung eindeutig identifiziert. Wenn hinzugefügt, unterstützt dies jedes Anforderungsdebugging und kann für idempotente Prüfungen verwendet werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
Vorname
|
data.forename | string |
Vorname |
|
Familienname
|
data.surname | string |
Familienname |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
Telefonnummer
|
data.phoneNumber | string |
Telefonnummer |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
zeile3
|
data.address.line3 | string |
zeile3 |
|
Zeile 4
|
data.address.line4 | string |
Zeile 4 |
|
Zeile5
|
data.address.line5 | string |
Zeile5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
E-Mail-Adresse
|
data.emailAddress | string |
E-Mail-Adresse |
|
gender
|
data.gender | string |
gender |
|
Nationalität
|
data.nationality | string |
Nationalität |
|
language
|
data.language | string |
language |
|
Ehestatus
|
data.maritalStatus | string |
Ehestatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
Mitarbeiter-ID
|
data.employment.employeeId | string |
Mitarbeiter-ID |
|
additionalEmployeeId
|
data.employment.additionalEmployeeId | string |
additionalEmployeeId |
|
startDate
|
data.employment.startDate | date |
startDate |
|
originalStartDate
|
data.employment.originalStartDate | date |
originalStartDate |
|
probationPassedDate
|
data.employment.probationPassedDate | date |
probationPassedDate |
|
lehrlingStartDate
|
data.employment.apprenticeStartDate | date |
lehrlingStartDate |
|
Berufsbezeichnung
|
data.employment.jobTitle | string |
Berufsbezeichnung |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
grade
|
data.employment.grade | string |
grade |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
Abteilung
|
data.employment.department | string |
Abteilung |
|
division
|
data.employment.division | string |
division |
|
businessUnit
|
data.employment.businessUnit | string |
businessUnit |
|
location
|
data.employment.location | string |
location |
|
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 |
|
Enddatum
|
data.employment.contractDetails.endDate | date |
Enddatum |
|
type
|
data.employment.contractDetails.type | string |
type |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
Gehalt
|
data.employment.salaryDetails.salary | double |
Gehalt |
|
salaryEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | date |
salaryEffectiveDate |
|
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 |
|
fundingLevel1
|
data.employment.funding.fundingLevel1 | string |
fundingLevel1 |
|
fundingLevel2
|
data.employment.funding.fundingLevel2 | string |
fundingLevel2 |
|
fundingLevel3
|
data.employment.funding.fundingLevel3 | string |
fundingLevel3 |
|
fundingLevel4
|
data.employment.funding.fundingLevel4 | string |
fundingLevel4 |
|
fundingLevel5
|
data.employment.funding.fundingLevel5 | string |
fundingLevel5 |
|
leaveDate
|
data.employment.leaveDate | date |
leaveDate |
|
terminationReason
|
data.employment.terminationReason | string |
terminationReason |
|
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 |
|
Zeitstempel
|
timestamp | date-time |
Zeitstempel |
Abrufen von Benutzervorteilsinformationen
Gibt Details des einzelnen Vorteils des authentifizierten Benutzers zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige Anforderungs-ID
|
X-Client-Request-Id | string |
Eine ID, die die Anforderung eindeutig identifiziert. Wenn hinzugefügt, unterstützt dies jedes Anforderungsdebugging und kann für idempotente Prüfungen verwendet werden. |
|
|
Eindeutiger Vorteilsbezeichner
|
benefit-key | True | string |
Spezifischer Schlüssel, der verwendet wird, um zu identifizieren, welche Vorteilsinformationen Sie für den jeweiligen Benutzer abrufen möchten |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
status
|
data.status | string |
status |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
jährlich
|
data.benefitCost.annual | double |
jährlich |
|
monatlich
|
data.benefitCost.monthly | double |
monatlich |
|
currency
|
data.benefitCost.currency | string |
currency |
|
jährlich
|
data.employeeContribution.annual | double |
jährlich |
|
monatlich
|
data.employeeContribution.monthly | double |
monatlich |
|
currency
|
data.employeeContribution.currency | string |
currency |
|
jährlich
|
data.employerContribution.annual | double |
jährlich |
|
monatlich
|
data.employerContribution.monthly | double |
monatlich |
|
currency
|
data.employerContribution.currency | string |
currency |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
Beschreibung
|
data.description | string |
Beschreibung |
|
Abschnitte
|
data.sections | array of object |
Abschnitte |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
Inhalt
|
data.sections.content | string |
Inhalt |
|
Abschnitte
|
data.sections.sections | array of object |
Abschnitte |
|
title
|
data.sections.sections.title | string |
title |
|
type
|
data.sections.sections.type | string |
type |
|
Inhalt
|
data.sections.sections.content | string |
Inhalt |
|
Häufig gestellte Fragen
|
data.faqs | array of object |
Häufig gestellte Fragen |
|
Frage
|
data.faqs.question | string |
Frage |
|
Antwort
|
data.faqs.answer | string |
Antwort |
|
needToKnow
|
data.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.usefulLinks | array of object |
usefulLinks |
|
URI
|
data.usefulLinks.uri | string |
URI |
|
linkText
|
data.usefulLinks.linkText | string |
linkText |
|
datesFormat
|
data.datesFormat | string |
datesFormat |
|
Zeitstempel
|
timestamp | date-time |
Zeitstempel |
Zusammenfassung der verfügbaren und berechtigten Vorteile des Benutzers
Gibt aktuelle und berechtigte Vorteile für den authentifizierten Benutzer zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige Anforderungs-ID
|
X-Client-Request-Id | string |
Eine ID, die die Anforderung eindeutig identifiziert. Wenn hinzugefügt, unterstützt dies jedes Anforderungsdebugging und kann für idempotente Prüfungen verwendet werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
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 |
|
status
|
data.currentBenefits.status | string |
status |
|
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 |
|
status
|
data.eligibleToAddBenefits.status | string |
status |
|
Zeitstempel
|
timestamp | date-time |
Zeitstempel |