Benifex (Önizleme)
Benifex platformu, tek ve birleşik bir deneyimle küresel çalışanların avantajlarını, refahını ve ödül yönetimini basitleştirir. Bu bağlayıcı Benifex platformuyla sorunsuz tümleştirme sağlayarak çalışan verilerine, avantaj seçimlerine ve uygunluk ayrıntılarına erişim sağlar
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Government bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Benifex Desteği |
| URL | https://benifex.com/contact-us |
| E-posta | et-noreply@benifex.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Benefex Ltd |
| Web sitesi | https://benifex.com |
| Gizlilik ilkesi | https://benifex.com/privacy-notice |
| Kategoriler | AI; İnsan Kaynakları |
Benifex Bağlayıcısı
Benifex, avantajlar, refah, tanıma ve katılım gibi alanlara odaklanarak çalışan deneyimi teknolojisi sunma konusunda uzmandır.
Müşterilerin ve çalışanların sevdiği olağanüstü deneyimler oluşturma misyonundayız.
Benifex bağlayıcısı, Benifex platformuyla veri tümleştirmesi sağlar.
Yayımcı: Benifex
Önkoşullar
Başlamak için Benifex Customer Success Manager'ınızla bir geliştirici hesabına kaydolun. Onaylandıktan sonra geliştirici portalımızın yönetici bölümüne bir bağlantı sağlanır.
Ayrıca benzersiz müşteriniz client_id ve secretile birlikte sağlanırsınız. Bu kimlik bilgilerine sahip olduktan sonra API'lerimizle iletişim kurabileceksiniz.
Daha fazla ayrıntı için Kimlik doğrulama kılavuzuna bakın.
Desteklenen İşlemler
- Kullanıcı Al: Benifex platformundan kimliği doğrulanmış kullanıcı bilgilerini alın.
- Özetlenmiş Avantajları Alma: Kimliği doğrulanmış kullanıcı için şu anda kullanılabilir olan ve eklemeye uygun avantajların özetini döndürür.
- Ayrıntılı Avantajları Edinin: Kimliği doğrulanmış kullanıcı için geçerli ve eklemeye uygun avantajlar hakkında ayrıntılı bilgi döndürür.
- Kullanıcı Avantajı Bilgilerini Alma: Kimliği doğrulanmış kullanıcı için belirli bir avantajla ilgili bilgileri döndürür.
Bu işlemler hakkında daha fazla bilgi için API başvuru belgelerine bakın.
Kimlik Bilgilerini Alma
API'mize erişmek için Önkoşullar bölümünde açıklandığı gibi gerekli kimlik bilgilerini almanız gerekir.
OAuth 2.0 İstemci Kimlik Bilgileri akışı kullanılarak bir JWT erişim belirteci alınır.
Kimlik bilgilerinizle kimlik doğrulaması yaparak JWT erişim belirtecinizi alın.
Belirteç uç noktası URI'sine bir
POSTistek gönderin:
https://auth.onehub.dev/auth/realms/default/protocol/openid-connect/tokenContent-Typeüst bilgi kümesini olarakapplication/x-www-form-urlencodedekleyin.HTTP gövdesine aşağıdakileri ekleyin:
client_idclient_secretgrant_type=client_credentials
Başlangıç Yapmak
Tüm belgeler, uygulama kılavuzları ve korumalı alan testi için Benifex API Portalı'nı ziyaret edin.
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Kullanıcı avantajı bilgilerini alma |
Kimliği doğrulanmış kullanıcının tek avantajının ayrıntılarını döndürür |
| Kullanıcı Bilgilerini Alma |
Kimliği doğrulanmış kullanıcının kullanıcı bilgilerini alın. |
| Kullanıcının ayrıntılı kullanılabilir ve uygun ek avantajlarına sahip olun |
Geçerli ve kimliği doğrulanmış kullanıcı için avantaj eklemeye uygun ayrıntıları döndürür |
| Kullanıcının özetlenmiş kullanılabilir ve uygun ek avantajlarına sahip olun |
Geçerli ve kimliği doğrulanmış kullanıcı için avantaj eklemeye uygun döndürür |
Kullanıcı avantajı bilgilerini alma
Kimliği doğrulanmış kullanıcının tek avantajının ayrıntılarını döndürür
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Benzersiz istek kimliği
|
X-Client-Request-Id | string |
İsteği benzersiz olarak tanımlayan bir kimlik. Eklenirse, bu, tüm istek hata ayıklamalarını yardımcı olur ve bir kez daha etkili denetimler için kullanılabilir. |
|
|
Benzersiz avantaj tanımlayıcısı
|
benefit-key | True | string |
Belirli bir kullanıcı için hangi avantaj bilgilerini almak istediğinizi belirlemek için kullanılan belirli anahtar |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
statü
|
data.status | string |
statü |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
yıllık
|
data.benefitCost.annual | double |
yıllık |
|
aylık
|
data.benefitCost.monthly | double |
aylık |
|
currency
|
data.benefitCost.currency | string |
currency |
|
yıllık
|
data.employeeContribution.annual | double |
yıllık |
|
aylık
|
data.employeeContribution.monthly | double |
aylık |
|
currency
|
data.employeeContribution.currency | string |
currency |
|
yıllık
|
data.employerContribution.annual | double |
yıllık |
|
aylık
|
data.employerContribution.monthly | double |
aylık |
|
currency
|
data.employerContribution.currency | string |
currency |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
açıklama
|
data.description | string |
açıklama |
|
Bölüm
|
data.sections | array of object |
Bölüm |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
içerik
|
data.sections.content | string |
içerik |
|
Bölüm
|
data.sections.sections | array of object |
Bölüm |
|
title
|
data.sections.sections.title | string |
title |
|
type
|
data.sections.sections.type | string |
type |
|
içerik
|
data.sections.sections.content | string |
içerik |
|
sss
|
data.faqs | array of object |
sss |
|
soru
|
data.faqs.question | string |
soru |
|
cevap
|
data.faqs.answer | string |
cevap |
|
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 |
|
Tarih damgası
|
timestamp | date-time |
Tarih damgası |
Kullanıcı Bilgilerini Alma
Kimliği doğrulanmış kullanıcının kullanıcı bilgilerini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Benzersiz istek kimliği
|
X-Client-Request-Id | string |
İsteği benzersiz olarak tanımlayan bir kimlik. Eklenirse, bu, tüm istek hata ayıklamalarını yardımcı olur ve bir kez daha etkili denetimler için kullanılabilir. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
data.id | string |
kimlik |
|
ilk ad
|
data.forename | string |
ilk ad |
|
soyadı
|
data.surname | string |
soyadı |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
telefon numarası
|
data.phoneNumber | string |
telefon numarası |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
satır3
|
data.address.line3 | string |
satır3 |
|
satır4
|
data.address.line4 | string |
satır4 |
|
satır5
|
data.address.line5 | string |
satır5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
e-posta adresi
|
data.emailAddress | string |
e-posta adresi |
|
cinsiyet
|
data.gender | string |
cinsiyet |
|
milliyet
|
data.nationality | string |
milliyet |
|
language
|
data.language | string |
language |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
çalışanKimliği
|
data.employment.employeeId | string |
çalışanKimliği |
|
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 |
|
iş unvanı
|
data.employment.jobTitle | string |
iş unvanı |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
derece
|
data.employment.grade | string |
derece |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
bölüm
|
data.employment.department | string |
bölüm |
|
bölüm
|
data.employment.division | string |
bölüm |
|
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 |
|
Bitiş Tarihi
|
data.employment.contractDetails.endDate | date |
Bitiş Tarihi |
|
type
|
data.employment.contractDetails.type | string |
type |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
maaş
|
data.employment.salaryDetails.salary | double |
maaş |
|
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 |
|
Tarih damgası
|
timestamp | date-time |
Tarih damgası |
Kullanıcının ayrıntılı kullanılabilir ve uygun ek avantajlarına sahip olun
Geçerli ve kimliği doğrulanmış kullanıcı için avantaj eklemeye uygun ayrıntıları döndürür
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Benzersiz istek kimliği
|
X-Client-Request-Id | string |
İsteği benzersiz olarak tanımlayan bir kimlik. Eklenirse, bu, tüm istek hata ayıklamalarını yardımcı olur ve bir kez daha etkili denetimler için kullanılabilir. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
statü
|
data.currentBenefits.status | string |
statü |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
yıllık
|
data.currentBenefits.benefitCost.annual | double |
yıllık |
|
aylık
|
data.currentBenefits.benefitCost.monthly | double |
aylık |
|
currency
|
data.currentBenefits.benefitCost.currency | string |
currency |
|
yıllık
|
data.currentBenefits.employeeContribution.annual | double |
yıllık |
|
aylık
|
data.currentBenefits.employeeContribution.monthly | double |
aylık |
|
currency
|
data.currentBenefits.employeeContribution.currency | string |
currency |
|
yıllık
|
data.currentBenefits.employerContribution.annual | double |
yıllık |
|
aylık
|
data.currentBenefits.employerContribution.monthly | double |
aylık |
|
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 |
|
açıklama
|
data.currentBenefits.description | string |
açıklama |
|
Bölüm
|
data.currentBenefits.sections | array of object |
Bölüm |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
içerik
|
data.currentBenefits.sections.content | string |
içerik |
|
Bölüm
|
data.currentBenefits.sections.sections | array of object |
Bölüm |
|
title
|
data.currentBenefits.sections.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.sections.type | string |
type |
|
içerik
|
data.currentBenefits.sections.sections.content | string |
içerik |
|
sss
|
data.currentBenefits.faqs | array of object |
sss |
|
soru
|
data.currentBenefits.faqs.question | string |
soru |
|
cevap
|
data.currentBenefits.faqs.answer | string |
cevap |
|
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 |
|
açıklama
|
data.eligibleToAddBenefits.description | string |
açıklama |
|
Bölüm
|
data.eligibleToAddBenefits.sections | array of object |
Bölüm |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
içerik
|
data.eligibleToAddBenefits.sections.content | string |
içerik |
|
Bölüm
|
data.eligibleToAddBenefits.sections.sections | array of object |
Bölüm |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.type | string |
type |
|
içerik
|
data.eligibleToAddBenefits.sections.sections.content | string |
içerik |
|
Bölüm
|
data.eligibleToAddBenefits.sections.sections.sections | array of object |
Bölüm |
|
title
|
data.eligibleToAddBenefits.sections.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.sections.type | string |
type |
|
içerik
|
data.eligibleToAddBenefits.sections.sections.sections.content | string |
içerik |
|
sss
|
data.eligibleToAddBenefits.faqs | array of object |
sss |
|
soru
|
data.eligibleToAddBenefits.faqs.question | string |
soru |
|
cevap
|
data.eligibleToAddBenefits.faqs.answer | string |
cevap |
|
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 |
|
Tarih damgası
|
timestamp | date-time |
Tarih damgası |
Kullanıcının özetlenmiş kullanılabilir ve uygun ek avantajlarına sahip olun
Geçerli ve kimliği doğrulanmış kullanıcı için avantaj eklemeye uygun döndürür
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Benzersiz istek kimliği
|
X-Client-Request-Id | string |
İsteği benzersiz olarak tanımlayan bir kimlik. Eklenirse, bu, tüm istek hata ayıklamalarını yardımcı olur ve bir kez daha etkili denetimler için kullanılabilir. |
Döndürülenler
| Name | Yol | Tür | 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 |
|
statü
|
data.currentBenefits.status | string |
statü |
|
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 |
|
statü
|
data.eligibleToAddBenefits.status | string |
statü |
|
Tarih damgası
|
timestamp | date-time |
Tarih damgası |