Partager via

Benifex (préversion)

La plateforme Benifex simplifie les avantages globaux des employés, le bien-être et la gestion des récompenses grâce à une expérience unique et unifiée. Ce connecteur permet une intégration transparente à la plateforme Benifex, en fournissant l’accès aux données des employés, aux sélections d’avantages et aux détails de l’éligibilité

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge de Benifex
URL https://benifex.com/contact-us
Messagerie électronique et-noreply@benifex.com
Métadonnées du connecteur
Éditeur Benefex Ltd
Site internet https://benifex.com
Politique de confidentialité https://benifex.com/privacy-notice
Catégories IA; Ressources humaines

Connecteur Benifex

Benifex se spécialise dans la fourniture de technologies d’expérience des employés, en se concentrant sur des domaines tels que les avantages, le bien-être, la reconnaissance et l’engagement.
Nous sommes sur une mission de construire des expériences remarquables que les clients et les employés aiment.
Le connecteur Benifex permet l’intégration des données à la plateforme Benifex.

Éditeur : Benifex

Prerequisites

Pour commencer, inscrivez-vous à un compte de développeur avec votre Gestionnaire de réussite client Benifex. Une fois approuvé, vous recevrez un lien vers la section d’administration de notre portail des développeurs.
Vous serez également fourni avec votre client client_id unique et secret. Une fois ces informations d’identification remplies, vous serez en mesure de communiquer avec nos API.
Pour plus d’informations, consultez le guide d’authentification.

Opérations prises en charge

  • Obtenir des utilisateurs existants : récupérer les utilisateurs existants par ID d’employé. Prend en charge la pagination.
  • Obtenir un utilisateur existant : récupérer un utilisateur spécifique à partir de la plateforme Benifex.
  • Obtenir les avantages résumés : retourne un résumé des avantages actuellement disponibles et éligibles à ajouter pour un utilisateur donné.
  • Obtenir des avantages détaillés : retourne des informations détaillées sur les avantages actuels et éligibles à ajouter pour un utilisateur donné.
  • Obtenir des informations sur les avantages utilisateur : retourne des informations sur un avantage spécifique pour un utilisateur spécifique.

Pour plus d’informations sur ces opérations, reportez-vous à la documentation de référence de l’API.

Obtention des informations d’identification

Pour accéder à notre API, vous devez obtenir les informations d’identification nécessaires, comme décrit dans la section Conditions préalables .
Un jeton d’accès JWT est obtenu à l’aide du flux d’informations d’identification du client OAuth 2.0.
Obtenez votre jeton d’accès JWT en vous authentifiant avec vos informations d’identification.

  1. Envoyez une POST requête à l’URI du point de terminaison de jeton :
    https://hub.onehub.global/oauth2/default/v1/token

  2. Ajoutez l’en-tête Content-Type défini sur application/x-www-form-urlencoded.

  3. Incluez ce qui suit dans le corps HTTP :

    • client_id
    • client_secret
    • grant_type=client_credentials

Getting Started

Pour obtenir une documentation complète, des guides d’implémentation et des tests de bac à sable, visitez le portail d’API Benifex.

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Obtenir des avantages détaillés disponibles et éligibles à ajouter de l’utilisateur

Retourne les détails actuels et éligibles pour ajouter des avantages pour l’utilisateur demandé
Obtenir des informations sur les avantages utilisateur

Retourne les détails de l’avantage unique de l’utilisateur demandé
Obtenir des utilisateurs existants

Obtenir des utilisateurs créés sur la plateforme Benifex par id d’employé avec prise en charge de la pagination
Obtenir un résumé des avantages disponibles et éligibles à ajouter de l’utilisateur

Retourne les avantages actuels et éligibles pour ajouter des avantages pour l’utilisateur demandé
Obtenir un utilisateur existant

Obtenir l’utilisateur créé sur la plateforme Benifex

Obtenir des avantages détaillés disponibles et éligibles à ajouter de l’utilisateur

ID d’opération :
GetDetailedAvailableAndEligibleToAddBenefitsOfUser

Retourne les détails actuels et éligibles pour ajouter des avantages pour l’utilisateur demandé

Paramètres

Nom Clé Obligatoire Type Description
ID unique de l’utilisateur
 user-id True string

ID spécifique de l’utilisateur sur lequel vous souhaitez obtenir des informations sur
Format de la réponse
 accept string

Définit le type de média attendu dans la réponse, généralement défini sur application/json pour recevoir des données au format JSON

Retours

Nom Chemin d’accès 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
annuel
 data.currentBenefits.benefitCost.annual double

annuel
mensuel
 data.currentBenefits.benefitCost.monthly double

mensuel
currency
 data.currentBenefits.benefitCost.currency string

currency
annuel
 data.currentBenefits.employeeContribution.annual double

annuel
mensuel
 data.currentBenefits.employeeContribution.monthly double

mensuel
currency
 data.currentBenefits.employeeContribution.currency string

currency
annuel
 data.currentBenefits.employerContribution.annual double

annuel
mensuel
 data.currentBenefits.employerContribution.monthly double

mensuel
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
descriptif
 data.currentBenefits.description string

descriptif
Sections
 data.currentBenefits.sections array of object

Sections
title
 data.currentBenefits.sections.title string

title
type
 data.currentBenefits.sections.type string

type
contenu
 data.currentBenefits.sections.content string

contenu
Sections
 data.currentBenefits.sections.sections array of

Sections
faqs
 data.currentBenefits.faqs array of object

faqs
question
 data.currentBenefits.faqs.question string

question
répondre
 data.currentBenefits.faqs.answer string

répondre
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
descriptif
 data.eligibleToAddBenefits.description string

descriptif
Sections
 data.eligibleToAddBenefits.sections array of object

Sections
title
 data.eligibleToAddBenefits.sections.title string

title
type
 data.eligibleToAddBenefits.sections.type string

type
contenu
 data.eligibleToAddBenefits.sections.content string

contenu
Sections
 data.eligibleToAddBenefits.sections.sections array of object

Sections
title
 data.eligibleToAddBenefits.sections.sections.title string

title
type
 data.eligibleToAddBenefits.sections.sections.type string

type
contenu
 data.eligibleToAddBenefits.sections.sections.content string

contenu
faqs
 data.eligibleToAddBenefits.faqs array of object

faqs
question
 data.eligibleToAddBenefits.faqs.question string

question
répondre
 data.eligibleToAddBenefits.faqs.answer string

répondre
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
horodatage
 timestamp date-time

horodatage

Obtenir des informations sur les avantages utilisateur

ID d’opération :
GetUserBenefitInformation

Retourne les détails de l’avantage unique de l’utilisateur demandé

Paramètres

Nom Clé Obligatoire Type Description
ID unique de l’utilisateur
 user-id True string

ID spécifique de l’utilisateur sur lequel vous souhaitez obtenir des informations sur
Identificateur d’avantage unique
 benefit-key True string

Clé spécifique utilisée pour identifier les informations d’avantage que vous souhaitez récupérer pour l’utilisateur donné

Retours

Nom Chemin d’accès Type Description
status
 data.status string

status
effectiveFrom
 data.effectiveFrom string

effectiveFrom
editableUntil
 data.editableUntil string

editableUntil
changeDate
 data.changeDate string

changeDate
annuel
 data.benefitCost.annual double

annuel
mensuel
 data.benefitCost.monthly double

mensuel
currency
 data.benefitCost.currency string

currency
annuel
 data.employeeContribution.annual double

annuel
mensuel
 data.employeeContribution.monthly double

mensuel
currency
 data.employeeContribution.currency string

currency
annuel
 data.employerContribution.annual double

annuel
mensuel
 data.employerContribution.monthly double

mensuel
currency
 data.employerContribution.currency string

currency
benefitKey
 data.benefitKey string

benefitKey
title
 data.title string

title
benefitLink
 data.benefitLink string

benefitLink
descriptif
 data.description string

descriptif
Sections
 data.sections array of object

Sections
title
 data.sections.title string

title
type
 data.sections.type string

type
contenu
 data.sections.content string

contenu
Sections
 data.sections.sections array of object

Sections
title
 data.sections.sections.title string

title
type
 data.sections.sections.type string

type
contenu
 data.sections.sections.content string

contenu
faqs
 data.faqs array of object

faqs
question
 data.faqs.question string

question
répondre
 data.faqs.answer string

répondre
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
horodatage
 timestamp date-time

horodatage

Obtenir des utilisateurs existants

ID d’opération :
GetExistingUsers

Obtenir des utilisateurs créés sur la plateforme Benifex par id d’employé avec prise en charge de la pagination

Paramètres

Nom Clé Obligatoire Type Description
ID d’employé à récupérer
 employeeIds True string

Identificateurs d’employés uniques utilisés pour filtrer les utilisateurs extraits à partir de la plateforme Benifex

Retours

Nom Chemin d’accès Type Description
page
 pagination.page integer

page
size
 pagination.size integer

size
totalPages
 pagination.totalPages integer

totalPages
totalItems
 pagination.totalItems integer

totalItems
hasNext
 pagination.hasNext boolean

hasNext
hasPrevious
 pagination.hasPrevious boolean

hasPrevious
données
 data array of object

données
pièce d'identité
 data.id string

pièce d'identité
adresse e-mail
 data.emailAddress string

adresse e-mail
prénom
 data.forename string

prénom
nom de famille
 data.surname string

nom de famille
employeeId
 data.employeeId string

employeeId
department
 data.department string

department
Intitulé du poste
 data.jobTitle string

Intitulé du poste
location
 data.location string

location
countryOfWork
 data.countryOfWork string

countryOfWork
dateOfBirth
 data.dateOfBirth date

dateOfBirth
date de début
 data.startDate date

date de début
businessUnit
 data.businessUnit string

businessUnit
gender
 data.gender string

gender
horodatage
 timestamp date-time

horodatage

Obtenir un résumé des avantages disponibles et éligibles à ajouter de l’utilisateur

ID d’opération :
GetSummarizedAvailableAndEligibleToAddBenefitsOfUser

Retourne les avantages actuels et éligibles pour ajouter des avantages pour l’utilisateur demandé

Paramètres

Nom Clé Obligatoire Type Description
ID unique de l’utilisateur
 user-id True string

ID spécifique de l’utilisateur sur lequel vous souhaitez obtenir des informations sur
Format de la réponse
 accept string

Définit le type de média attendu dans la réponse, généralement défini sur application/json pour recevoir des données au format JSON

Retours

Nom Chemin d’accès 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
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
horodatage
 timestamp date-time

horodatage

Obtenir un utilisateur existant

ID d’opération :
GetExistingUser

Obtenir l’utilisateur créé sur la plateforme Benifex

Paramètres

Nom Clé Obligatoire Type Description
ID unique de l’utilisateur
 user-id True string

ID spécifique de l’utilisateur sur lequel vous souhaitez obtenir des informations sur

Retours

Nom Chemin d’accès Type Description
pièce d'identité
 data.id string

pièce d'identité
prénom
 data.forename string

prénom
nom de famille
 data.surname string

nom de famille
dateOfBirth
 data.dateOfBirth date

dateOfBirth
title
 data.title string

title
preferredName
 data.preferredName string

preferredName
localName
 data.localName string

localName
numéro de téléphone
 data.phoneNumber string

numéro de téléphone
line1
 data.address.line1 string

line1
line2
 data.address.line2 string

line2
line3
 data.address.line3 string

line3
ligne4
 data.address.line4 string

ligne4
ligne 5
 data.address.line5 string

ligne 5
postcodeZipCode
 data.address.postcodeZipCode string

postcodeZipCode
country
 data.address.country string

country
adresse e-mail
 data.emailAddress string

adresse e-mail
gender
 data.gender string

gender
nationalité
 data.nationality string

nationalité
language
 data.language string

language
maritalStatus
 data.maritalStatus string

maritalStatus
effectiveDateOfMaritalStatus
 data.effectiveDateOfMaritalStatus date

effectiveDateOfMaritalStatus
employeeId
 data.employment.employeeId string

employeeId
additionalEmployeeId
 data.employment.additionalEmployeeId string

additionalEmployeeId
date de début
 data.employment.startDate date

date de début
originalStartDate
 data.employment.originalStartDate date

originalStartDate
probationPassedDate
 data.employment.probationPassedDate date

probationPassedDate
apprenticeStartDate
 data.employment.apprenticeStartDate date

apprenticeStartDate
leaveDate
 data.employment.leaveDate date

leaveDate
terminationReason
 data.employment.terminationReason string

terminationReason
Intitulé du poste
 data.employment.jobTitle string

Intitulé du poste
employmentStatus
 data.employment.employmentStatus string

employmentStatus
grade
 data.employment.grade string

grade
legalEmployerCompany
 data.employment.legalEmployerCompany string

legalEmployerCompany
department
 data.employment.department string

department
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
payGroup
 data.employment.salaryDetails.payGroup string

payGroup
salaire
 data.employment.salaryDetails.salary double

salaire
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
date de début
 data.employment.contractDetails.startDate date

date de début
date de fin
 data.employment.contractDetails.endDate date

date de fin
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
horodatage
 timestamp date-time

horodatage