Benifex (preview)
Het Benifex-platform vereenvoudigt wereldwijde werknemersvoordelen, welzijn en beloningsbeheer via één uniforme ervaring. Deze connector maakt naadloze integratie mogelijk met het Benifex-platform, biedt toegang tot gegevens van werknemers, selecties van voordelen en geschiktheidsgegevens
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Benifex-ondersteuning |
| URL | https://benifex.com/contact-us |
| E-mailen | et-noreply@benifex.com |
| Connector-metagegevens | |
|---|---|
| Uitgever | Benefex Ltd |
| Webpagina | https://benifex.com |
| Privacybeleid | https://benifex.com/privacy-notice |
| Categorieën | AI; Personeel |
Benifex-connector
Benifex is gespecialiseerd in het leveren van technologie voor werknemerservaring, gericht op gebieden zoals voordelen, welzijn, erkenning en betrokkenheid.
We zijn op een missie om opmerkelijke ervaringen op te bouwen waar klanten en werknemers van houden.
De Benifex-connector maakt gegevensintegratie mogelijk met het Benifex-platform.
Uitgever: Benifex
Vereiste voorwaarden
Meld u aan voor een ontwikkelaarsaccount met uw Benifex Customer Success Manager om aan de slag te gaan. Zodra dit is goedgekeurd, krijgt u een koppeling naar de beheersectie van onze ontwikkelaarsportal.
U wordt ook geleverd bij uw unieke klant client_id en secret. Zodra u deze referenties hebt, kunt u communiceren met onze API's.
Raadpleeg de verificatiehandleiding voor meer informatie.
Ondersteunde bewerkingen
- Bestaande gebruikers ophalen: bestaande gebruikers ophalen op werknemer-id. Ondersteunt paginering.
- Bestaande gebruiker ophalen: haal een specifieke gebruiker op uit het Benifex-platform.
- Samengevatte voordelen ophalen: retourneert een samenvatting van de momenteel beschikbare en in aanmerking komende voordelen voor een bepaalde gebruiker.
- Gedetailleerde voordelen krijgen: retourneert gedetailleerde informatie over de huidige en in aanmerking komende voordelen voor een bepaalde gebruiker.
- Informatie over gebruikersvoordeel ophalen: retourneert informatie over een specifiek voordeel voor een specifieke gebruiker.
Raadpleeg de API-referentiedocumentatie voor meer informatie over deze bewerkingen.
Referenties verkrijgen
Voor toegang tot onze API moet u de benodigde referenties verkrijgen, zoals beschreven in de sectie Vereisten .
Er wordt een JWT-toegangstoken verkregen met behulp van de OAuth 2.0-clientreferentiestroom.
Haal uw JWT-toegangstoken op door uw referenties te verifiëren.
POSTEen aanvraag verzenden naar de eindpunt-URI van het token:
https://hub.onehub.global/oauth2/default/v1/tokenVoeg de
Content-Typekoptekst toe aanapplication/x-www-form-urlencoded.Neem het volgende op in de HTTP-hoofdtekst:
client_idclient_secretgrant_type=client_credentials
Aan de slag komen
Ga naar de Benifex-API-portal voor volledige documentatie, implementatiehandleidingen en sandboxtests.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Bestaande gebruiker ophalen |
Maak een gebruiker op het Benifex-platform |
| Bestaande gebruikers ophalen |
Maak gebruikers op het Benifex-platform door werknemers-id's met pagineringsondersteuning |
| Informatie over gebruikersvoordelen ophalen |
Geeft als resultaat de details van één voordeel van de aangevraagde gebruiker |
| Krijg gedetailleerde beschikbare en in aanmerking komende voordelen van de gebruiker |
Retourneert details van de huidige en in aanmerking komende om voordelen toe te voegen voor de aangevraagde gebruiker |
| Samengevatte beschikbare en in aanmerking komende voordelen van de gebruiker |
Retourneert huidige en komt in aanmerking om voordelen toe te voegen voor de aangevraagde gebruiker |
Bestaande gebruiker ophalen
Maak een gebruiker op het Benifex-platform
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van de gebruiker
|
user-id | True | string |
Specifieke id van de gebruiker over wie u informatie wilt ophalen |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
data.id | string |
identiteitskaart |
|
voornaam
|
data.forename | string |
voornaam |
|
achternaam
|
data.surname | string |
achternaam |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
telefoonnummer
|
data.phoneNumber | string |
telefoonnummer |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
regel3
|
data.address.line3 | string |
regel3 |
|
regel4
|
data.address.line4 | string |
regel4 |
|
regel5
|
data.address.line5 | string |
regel5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
emailadres
|
data.emailAddress | string |
emailadres |
|
gender
|
data.gender | string |
gender |
|
nationaliteit
|
data.nationality | string |
nationaliteit |
|
language
|
data.language | string |
language |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
medewerker-ID
|
data.employment.employeeId | string |
medewerker-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 |
|
apprenticeStartDate
|
data.employment.apprenticeStartDate | date |
apprenticeStartDate |
|
leaveDate
|
data.employment.leaveDate | date |
leaveDate |
|
beëindigingReden
|
data.employment.terminationReason | string |
beëindigingReden |
|
functietitel
|
data.employment.jobTitle | string |
functietitel |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
graad
|
data.employment.grade | string |
graad |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
afdeling
|
data.employment.department | string |
afdeling |
|
divisie
|
data.employment.division | string |
divisie |
|
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 |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
salaris
|
data.employment.salaryDetails.salary | double |
salaris |
|
salarisEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | date |
salarisEffectiveDate |
|
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 |
|
startDate
|
data.employment.contractDetails.startDate | date |
startDate |
|
einddatum
|
data.employment.contractDetails.endDate | date |
einddatum |
|
type
|
data.employment.contractDetails.type | string |
type |
|
nationalIdentityNumber1
|
data.nationalIdentity.nationalIdentityNumber1 | string |
nationalIdentityNumber1 |
|
nationalIdentityNumber2
|
data.nationalIdentity.nationalIdentityNumber2 | string |
nationalIdentityNumber2 |
|
nationalIdentityNumber3
|
data.nationalIdentity.nationalIdentityNumber3 | string |
nationalIdentityNumber3 |
|
nationalIdentityCountry
|
data.nationalIdentity.nationalIdentityCountry | string |
nationalIdentityCountry |
|
customAttributes
|
data.customAttributes | object |
customAttributes |
|
tijdstempel
|
timestamp | date-time |
tijdstempel |
Bestaande gebruikers ophalen
Maak gebruikers op het Benifex-platform door werknemers-id's met pagineringsondersteuning
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Werknemer-id's die moeten worden opgehaald
|
employeeIds | True | string |
Unieke werknemers-id's die worden gebruikt om de gebruikers te filteren die worden opgehaald uit het Benifex-platform |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
page
|
pagination.page | integer |
page |
|
size
|
pagination.size | integer |
size |
|
totalPages
|
pagination.totalPages | integer |
totalPages |
|
totaalItems
|
pagination.totalItems | integer |
totaalItems |
|
hasNext
|
pagination.hasNext | boolean |
hasNext |
|
hasPrevious
|
pagination.hasPrevious | boolean |
hasPrevious |
|
gegevens
|
data | array of object |
gegevens |
|
identiteitskaart
|
data.id | string |
identiteitskaart |
|
emailadres
|
data.emailAddress | string |
emailadres |
|
voornaam
|
data.forename | string |
voornaam |
|
achternaam
|
data.surname | string |
achternaam |
|
medewerker-ID
|
data.employeeId | string |
medewerker-ID |
|
afdeling
|
data.department | string |
afdeling |
|
functietitel
|
data.jobTitle | string |
functietitel |
|
location
|
data.location | string |
location |
|
countryOfWork
|
data.countryOfWork | string |
countryOfWork |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
startDate
|
data.startDate | date |
startDate |
|
businessUnit
|
data.businessUnit | string |
businessUnit |
|
gender
|
data.gender | string |
gender |
|
tijdstempel
|
timestamp | date-time |
tijdstempel |
Informatie over gebruikersvoordelen ophalen
Geeft als resultaat de details van één voordeel van de aangevraagde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van de gebruiker
|
user-id | True | string |
Specifieke id van de gebruiker over wie u informatie wilt ophalen |
|
Unieke voordeel-id
|
benefit-key | True | string |
Specifieke sleutel die wordt gebruikt om te bepalen welke voordeelgegevens u wilt ophalen voor de opgegeven gebruiker |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
status
|
data.status | string |
status |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
jaarlijks
|
data.benefitCost.annual | double |
jaarlijks |
|
maandelijks
|
data.benefitCost.monthly | double |
maandelijks |
|
currency
|
data.benefitCost.currency | string |
currency |
|
jaarlijks
|
data.employeeContribution.annual | double |
jaarlijks |
|
maandelijks
|
data.employeeContribution.monthly | double |
maandelijks |
|
currency
|
data.employeeContribution.currency | string |
currency |
|
jaarlijks
|
data.employerContribution.annual | double |
jaarlijks |
|
maandelijks
|
data.employerContribution.monthly | double |
maandelijks |
|
currency
|
data.employerContribution.currency | string |
currency |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
beschrijving
|
data.description | string |
beschrijving |
|
Secties
|
data.sections | array of object |
Secties |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
inhoud
|
data.sections.content | string |
inhoud |
|
Secties
|
data.sections.sections | array of object |
Secties |
|
title
|
data.sections.sections.title | string |
title |
|
type
|
data.sections.sections.type | string |
type |
|
inhoud
|
data.sections.sections.content | string |
inhoud |
|
veelgestelde vragen
|
data.faqs | array of object |
veelgestelde vragen |
|
vraag
|
data.faqs.question | string |
vraag |
|
antwoorden
|
data.faqs.answer | string |
antwoorden |
|
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 |
|
tijdstempel
|
timestamp | date-time |
tijdstempel |
Krijg gedetailleerde beschikbare en in aanmerking komende voordelen van de gebruiker
Retourneert details van de huidige en in aanmerking komende om voordelen toe te voegen voor de aangevraagde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van de gebruiker
|
user-id | True | string |
Specifieke id van de gebruiker over wie u informatie wilt ophalen |
|
Antwoordindeling
|
accept | string |
Definieert het mediatype dat in het antwoord wordt verwacht, meestal ingesteld op toepassing/json om JSON-geformatteerde gegevens te ontvangen |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
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 |
|
jaarlijks
|
data.currentBenefits.benefitCost.annual | double |
jaarlijks |
|
maandelijks
|
data.currentBenefits.benefitCost.monthly | double |
maandelijks |
|
currency
|
data.currentBenefits.benefitCost.currency | string |
currency |
|
jaarlijks
|
data.currentBenefits.employeeContribution.annual | double |
jaarlijks |
|
maandelijks
|
data.currentBenefits.employeeContribution.monthly | double |
maandelijks |
|
currency
|
data.currentBenefits.employeeContribution.currency | string |
currency |
|
jaarlijks
|
data.currentBenefits.employerContribution.annual | double |
jaarlijks |
|
maandelijks
|
data.currentBenefits.employerContribution.monthly | double |
maandelijks |
|
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 |
|
beschrijving
|
data.currentBenefits.description | string |
beschrijving |
|
Secties
|
data.currentBenefits.sections | array of object |
Secties |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
inhoud
|
data.currentBenefits.sections.content | string |
inhoud |
|
Secties
|
data.currentBenefits.sections.sections | array of |
Secties |
|
veelgestelde vragen
|
data.currentBenefits.faqs | array of object |
veelgestelde vragen |
|
vraag
|
data.currentBenefits.faqs.question | string |
vraag |
|
antwoorden
|
data.currentBenefits.faqs.answer | string |
antwoorden |
|
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 |
|
in aanmerking komendeToAddBenefits
|
data.eligibleToAddBenefits | array of object |
in aanmerking komendeToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
beschrijving
|
data.eligibleToAddBenefits.description | string |
beschrijving |
|
Secties
|
data.eligibleToAddBenefits.sections | array of object |
Secties |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
inhoud
|
data.eligibleToAddBenefits.sections.content | string |
inhoud |
|
Secties
|
data.eligibleToAddBenefits.sections.sections | array of object |
Secties |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.type | string |
type |
|
inhoud
|
data.eligibleToAddBenefits.sections.sections.content | string |
inhoud |
|
veelgestelde vragen
|
data.eligibleToAddBenefits.faqs | array of object |
veelgestelde vragen |
|
vraag
|
data.eligibleToAddBenefits.faqs.question | string |
vraag |
|
antwoorden
|
data.eligibleToAddBenefits.faqs.answer | string |
antwoorden |
|
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 |
|
tijdstempel
|
timestamp | date-time |
tijdstempel |
Samengevatte beschikbare en in aanmerking komende voordelen van de gebruiker
Retourneert huidige en komt in aanmerking om voordelen toe te voegen voor de aangevraagde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van de gebruiker
|
user-id | True | string |
Specifieke id van de gebruiker over wie u informatie wilt ophalen |
|
Antwoordindeling
|
accept | string |
Definieert het mediatype dat in het antwoord wordt verwacht, meestal ingesteld op toepassing/json om JSON-geformatteerde gegevens te ontvangen |
Retouren
| Name | Pad | Type | 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 |
|
status
|
data.currentBenefits.status | string |
status |
|
in aanmerking komendeToAddBenefits
|
data.eligibleToAddBenefits | array of object |
in aanmerking komendeToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
status
|
data.eligibleToAddBenefits.status | string |
status |
|
tijdstempel
|
timestamp | date-time |
tijdstempel |