Benifex (anteprima)
La piattaforma Benifex semplifica i vantaggi, il benessere e la gestione dei premi dei dipendenti globali attraverso un'unica esperienza unificata. Questo connettore consente una perfetta integrazione con la piattaforma Benifex, fornendo l'accesso ai dati dei dipendenti, alle selezioni dei vantaggi e ai dettagli di idoneità
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Supporto benifex |
| URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Metadati del connettore | |
|---|---|
| Editore | Benefex Ltd |
| Sito web | https://benifex.com |
| Informativa sulla privacy | https://benifex.com/privacy-notice |
| Categorie | IA; Risorse umane |
Connettore Benifex
Benifex è specializzata nella fornitura di tecnologia di esperienza dei dipendenti, concentrandosi su aree quali benefici, benessere, riconoscimento e coinvolgimento.
Siamo in missione per creare esperienze straordinarie che i clienti e i dipendenti amano.
Il connettore Benifex consente l'integrazione dei dati con la piattaforma Benifex.
Editore: Benifex
Prerequisiti
Per iniziare, iscriversi per ottenere un account per sviluppatore con Benifex Customer Success Manager. Dopo l'approvazione, verrà fornito un collegamento alla sezione di amministrazione del portale per sviluppatori.
Inoltre, verrà fornito con il cliente e con il cliente client_id unico.secret Dopo aver ottenuto queste credenziali, sarà possibile comunicare con le API.
Per altri dettagli, vedere la Guida all'autenticazione.
Operazioni supportate
- Ottieni utente: recupera le informazioni utente autenticate dalla piattaforma Benifex.
- Ottenere i vantaggi riepilogati: restituisce un riepilogo dei vantaggi attualmente disponibili e idonei per l'utente autenticato.
- Ottenere vantaggi dettagliati: restituisce informazioni dettagliate sui vantaggi correnti e idonei per l'utente autenticato.
- Ottenere informazioni sui vantaggi utente: restituisce informazioni su un vantaggio specifico per l'utente autenticato.
Per altre informazioni su queste operazioni, vedere la documentazione di riferimento sulle API.
Recupero delle credenziali
Per accedere all'API, è necessario ottenere le credenziali necessarie, come descritto nella sezione Prerequisiti .
Un token di accesso JWT viene ottenuto usando il flusso di credenziali client OAuth 2.0.
Ottenere il token di accesso JWT eseguendo l'autenticazione con le credenziali.
Inviare una
POSTrichiesta all'URI dell'endpoint del token:
https://auth.onehub.dev/auth/realms/default/protocol/openid-connect/tokenAggiungere l'intestazione
Content-Typeimpostata suapplication/x-www-form-urlencoded.Includere quanto segue nel corpo HTTP:
client_idclient_secretgrant_type=client_credentials
Come iniziare
Per la documentazione completa, le guide all'implementazione e i test sandbox, visitare il portale api Benifex.
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Ottenere informazioni sui vantaggi dell'utente |
Restituisce i dettagli del singolo vantaggio dell'utente autenticato |
| Ottenere informazioni sull'utente |
Ottenere informazioni utente per l'utente autenticato. |
| Ottenere un riepilogo dei vantaggi disponibili e idonei per l'aggiunta di utenti |
Restituisce l'elemento corrente e idoneo per aggiungere vantaggi per l'utente autenticato |
| Ottenere vantaggi dettagliati disponibili e idonei per l'aggiunta di utenti |
Restituisce i dettagli dell'elemento corrente e idoneo per aggiungere vantaggi per l'utente autenticato |
Ottenere informazioni sui vantaggi dell'utente
Restituisce i dettagli del singolo vantaggio dell'utente autenticato
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta univoco
|
X-Client-Request-Id | string |
ID che identifica in modo univoco la richiesta. Se aggiunto, questo consente di eseguire il debug delle richieste e può essere usato per i controlli di idempotenza. |
|
|
Identificatore univoco del vantaggio
|
benefit-key | True | string |
Chiave specifica usata per identificare le informazioni sui vantaggi da recuperare per l'utente specificato |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
status
|
data.status | string |
status |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
annuale
|
data.benefitCost.annual | double |
annuale |
|
mensile
|
data.benefitCost.monthly | double |
mensile |
|
currency
|
data.benefitCost.currency | string |
currency |
|
annuale
|
data.employeeContribution.annual | double |
annuale |
|
mensile
|
data.employeeContribution.monthly | double |
mensile |
|
currency
|
data.employeeContribution.currency | string |
currency |
|
annuale
|
data.employerContribution.annual | double |
annuale |
|
mensile
|
data.employerContribution.monthly | double |
mensile |
|
currency
|
data.employerContribution.currency | string |
currency |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
descrizione
|
data.description | string |
descrizione |
|
Sezioni
|
data.sections | array of object |
Sezioni |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
contenuto
|
data.sections.content | string |
contenuto |
|
Sezioni
|
data.sections.sections | array of object |
Sezioni |
|
title
|
data.sections.sections.title | string |
title |
|
type
|
data.sections.sections.type | string |
type |
|
contenuto
|
data.sections.sections.content | string |
contenuto |
|
Domande frequenti
|
data.faqs | array of object |
Domande frequenti |
|
domanda
|
data.faqs.question | string |
domanda |
|
risposta
|
data.faqs.answer | string |
risposta |
|
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 |
|
Marca temporale
|
timestamp | date-time |
Marca temporale |
Ottenere informazioni sull'utente
Ottenere informazioni utente per l'utente autenticato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta univoco
|
X-Client-Request-Id | string |
ID che identifica in modo univoco la richiesta. Se aggiunto, questo consente di eseguire il debug delle richieste e può essere usato per i controlli di idempotenza. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
nome di battesimo
|
data.forename | string |
nome di battesimo |
|
cognome
|
data.surname | string |
cognome |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
numero di telefono
|
data.phoneNumber | string |
numero di telefono |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
line3
|
data.address.line3 | string |
line3 |
|
line4
|
data.address.line4 | string |
line4 |
|
riga5
|
data.address.line5 | string |
riga5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
indirizzo email
|
data.emailAddress | string |
indirizzo email |
|
genere
|
data.gender | string |
genere |
|
nazionalità
|
data.nationality | string |
nazionalità |
|
language
|
data.language | string |
language |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
ID dipendente
|
data.employment.employeeId | string |
ID dipendente |
|
additionalEmployeeId
|
data.employment.additionalEmployeeId | string |
additionalEmployeeId |
|
startDate
|
data.employment.startDate | date |
startDate |
|
originalStartDate
|
data.employment.originalStartDate | date |
originalStartDate |
|
probationPassedDate
|
data.employment.probationPassedDate | date |
probationPassedDate |
|
apprendistaStartDate
|
data.employment.apprenticeStartDate | date |
apprendistaStartDate |
|
titolo di lavoro
|
data.employment.jobTitle | string |
titolo di lavoro |
|
occupazioneStatus
|
data.employment.employmentStatus | string |
occupazioneStatus |
|
grado
|
data.employment.grade | string |
grado |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
dipartimento
|
data.employment.department | string |
dipartimento |
|
divisione
|
data.employment.division | string |
divisione |
|
businessUnit
|
data.employment.businessUnit | string |
businessUnit |
|
ubicazione
|
data.employment.location | string |
ubicazione |
|
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 |
|
Data di fine
|
data.employment.contractDetails.endDate | date |
Data di fine |
|
type
|
data.employment.contractDetails.type | string |
type |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
stipendio
|
data.employment.salaryDetails.salary | double |
stipendio |
|
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 |
|
Marca temporale
|
timestamp | date-time |
Marca temporale |
Ottenere un riepilogo dei vantaggi disponibili e idonei per l'aggiunta di utenti
Restituisce l'elemento corrente e idoneo per aggiungere vantaggi per l'utente autenticato
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta univoco
|
X-Client-Request-Id | string |
ID che identifica in modo univoco la richiesta. Se aggiunto, questo consente di eseguire il debug delle richieste e può essere usato per i controlli di idempotenza. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
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 |
|
Marca temporale
|
timestamp | date-time |
Marca temporale |
Ottenere vantaggi dettagliati disponibili e idonei per l'aggiunta di utenti
Restituisce i dettagli dell'elemento corrente e idoneo per aggiungere vantaggi per l'utente autenticato
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta univoco
|
X-Client-Request-Id | string |
ID che identifica in modo univoco la richiesta. Se aggiunto, questo consente di eseguire il debug delle richieste e può essere usato per i controlli di idempotenza. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
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 |
|
annuale
|
data.currentBenefits.benefitCost.annual | double |
annuale |
|
mensile
|
data.currentBenefits.benefitCost.monthly | double |
mensile |
|
currency
|
data.currentBenefits.benefitCost.currency | string |
currency |
|
annuale
|
data.currentBenefits.employeeContribution.annual | double |
annuale |
|
mensile
|
data.currentBenefits.employeeContribution.monthly | double |
mensile |
|
currency
|
data.currentBenefits.employeeContribution.currency | string |
currency |
|
annuale
|
data.currentBenefits.employerContribution.annual | double |
annuale |
|
mensile
|
data.currentBenefits.employerContribution.monthly | double |
mensile |
|
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 |
|
descrizione
|
data.currentBenefits.description | string |
descrizione |
|
Sezioni
|
data.currentBenefits.sections | array of object |
Sezioni |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
contenuto
|
data.currentBenefits.sections.content | string |
contenuto |
|
Sezioni
|
data.currentBenefits.sections.sections | array of object |
Sezioni |
|
title
|
data.currentBenefits.sections.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.sections.type | string |
type |
|
contenuto
|
data.currentBenefits.sections.sections.content | string |
contenuto |
|
Domande frequenti
|
data.currentBenefits.faqs | array of object |
Domande frequenti |
|
domanda
|
data.currentBenefits.faqs.question | string |
domanda |
|
risposta
|
data.currentBenefits.faqs.answer | string |
risposta |
|
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 |
|
descrizione
|
data.eligibleToAddBenefits.description | string |
descrizione |
|
Sezioni
|
data.eligibleToAddBenefits.sections | array of object |
Sezioni |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
contenuto
|
data.eligibleToAddBenefits.sections.content | string |
contenuto |
|
Sezioni
|
data.eligibleToAddBenefits.sections.sections | array of object |
Sezioni |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.type | string |
type |
|
contenuto
|
data.eligibleToAddBenefits.sections.sections.content | string |
contenuto |
|
Sezioni
|
data.eligibleToAddBenefits.sections.sections.sections | array of object |
Sezioni |
|
title
|
data.eligibleToAddBenefits.sections.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.sections.type | string |
type |
|
contenuto
|
data.eligibleToAddBenefits.sections.sections.sections.content | string |
contenuto |
|
Domande frequenti
|
data.eligibleToAddBenefits.faqs | array of object |
Domande frequenti |
|
domanda
|
data.eligibleToAddBenefits.faqs.question | string |
domanda |
|
risposta
|
data.eligibleToAddBenefits.faqs.answer | string |
risposta |
|
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 |
|
Marca temporale
|
timestamp | date-time |
Marca temporale |