Benifex (wersja zapoznawcza)
Platforma Benifex upraszcza globalne świadczenia pracowników, dobre samopoczucie i zarządzanie nagrodami za pomocą jednego, ujednoliconego środowiska. Ten łącznik umożliwia bezproblemową integrację z platformą Benifex, zapewniając dostęp do danych pracowników, wyborów korzyści i szczegółów uprawnień
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Pomoc techniczna firmy Benifex |
| adres URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Metadane łącznika | |
|---|---|
| Publisher | Benefex Ltd |
| Witryna internetowa | https://benifex.com |
| Zasady ochrony prywatności | https://benifex.com/privacy-notice |
| Kategorie | AI; Zasoby ludzkie |
Łącznik Benifex
Benifex specjalizuje się w dostarczaniu technologii doświadczeń pracowników, koncentrując się na takich obszarach, jak korzyści, dobre samopoczucie, uznanie i zaangażowanie.
Pracujemy nad misją budowania niezwykłych doświadczeń, które kochają klienci i pracownicy.
Łącznik Benifex umożliwia integrację danych z platformą Benifex.
Wydawca: Benifex
Wymagania wstępne
Aby rozpocząć, utwórz konto dewelopera za pomocą menedżera sukcesu klienta Benifex. Po zatwierdzeniu zostanie wyświetlony link do sekcji administratora portalu dla deweloperów.
Otrzymasz również unikatowy klient client_id i secret. Po utworzeniu tych poświadczeń będzie można komunikować się z naszymi interfejsami API.
Aby uzyskać więcej informacji, zapoznaj się z przewodnikiem uwierzytelniania.
Obsługiwane operacje
- Pobieranie istniejących użytkowników: pobieranie istniejących użytkowników według identyfikatora pracownika. Obsługuje stronicowanie.
- Pobierz istniejącego użytkownika: pobierz określonego użytkownika z platformy Benifex.
- Pobieranie podsumowanych korzyści: zwraca podsumowanie aktualnie dostępnych i kwalifikujących się korzyści dla danego użytkownika.
- Uzyskaj szczegółowe korzyści: zwraca szczegółowe informacje na temat bieżących i kwalifikujących się do dodania korzyści dla danego użytkownika.
- Uzyskaj informacje o korzyści użytkownika: zwraca informacje o określonej korzyści dla określonego użytkownika.
Aby uzyskać więcej informacji na temat tych operacji, zapoznaj się z dokumentacją referencyjną interfejsu API.
Uzyskiwanie poświadczeń
Aby uzyskać dostęp do naszego interfejsu API, należy uzyskać niezbędne poświadczenia zgodnie z opisem w sekcji Wymagania wstępne .
Token dostępu JWT jest uzyskiwany przy użyciu przepływu poświadczeń klienta OAuth 2.0.
Uzyskaj token dostępu JWT, uwierzytelniając się przy użyciu poświadczeń.
POSTWyślij żądanie do identyfikatora URI punktu końcowego tokenu:
https://hub.onehub.global/oauth2/default/v1/tokenContent-TypeDodaj nagłówek ustawiony naapplication/x-www-form-urlencoded.Uwzględnij następujące elementy w treści protokołu HTTP:
client_idclient_secretgrant_type=client_credentials
Wprowadzenie
Aby uzyskać pełną dokumentację, przewodniki implementacji i testowanie piaskownicy, odwiedź portal interfejsu API Benifex.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie istniejącego użytkownika |
Uzyskiwanie utworzonego użytkownika na platformie Benifex |
| Pobieranie istniejących użytkowników |
Uzyskiwanie utworzonych użytkowników na platformie Benifex według identyfikatorów pracowników z obsługą stronicowania |
| Uzyskiwanie informacji o korzyściach dla użytkowników |
Zwraca szczegóły pojedynczej korzyści dla żądanego użytkownika |
| Uzyskiwanie podsumowanych dostępnych i kwalifikujących się do dodania korzyści użytkownika |
Zwraca bieżące i kwalifikujące się do dodania korzyści dla żądanego użytkownika |
| Uzyskiwanie szczegółowych dostępnych i kwalifikujących się do dodania korzyści związanych z użytkownikiem |
Zwraca szczegóły bieżącego i uprawnionego do dodawania korzyści dla żądanego użytkownika |
Pobieranie istniejącego użytkownika
Uzyskiwanie utworzonego użytkownika na platformie Benifex
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator użytkownika
|
user-id | True | string |
Określony identyfikator użytkownika, o którym chcesz uzyskać informacje |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
imię
|
data.forename | string |
imię |
|
nazwisko
|
data.surname | string |
nazwisko |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
nazwa_lokalna
|
data.localName | string |
nazwa_lokalna |
|
numer telefonu
|
data.phoneNumber | string |
numer telefonu |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
line3
|
data.address.line3 | string |
line3 |
|
line4
|
data.address.line4 | string |
line4 |
|
line5
|
data.address.line5 | string |
line5 |
|
kod pocztowyZipCode
|
data.address.postcodeZipCode | string |
kod pocztowyZipCode |
|
country
|
data.address.country | string |
country |
|
adres e-mail
|
data.emailAddress | string |
adres e-mail |
|
gender
|
data.gender | string |
gender |
|
narodowość
|
data.nationality | string |
narodowość |
|
język
|
data.language | string |
język |
|
stan cywilny
|
data.maritalStatus | string |
stan cywilny |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
identyfikator pracownika
|
data.employment.employeeId | string |
identyfikator pracownika |
|
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 |
|
terminationReason
|
data.employment.terminationReason | string |
terminationReason |
|
tytuł stanowiska
|
data.employment.jobTitle | string |
tytuł stanowiska |
|
stan zatrudnienia
|
data.employment.employmentStatus | string |
stan zatrudnienia |
|
ocena
|
data.employment.grade | string |
ocena |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
departament
|
data.employment.department | string |
departament |
|
dzielenie
|
data.employment.division | string |
dzielenie |
|
businessUnit
|
data.employment.businessUnit | string |
businessUnit |
|
lokalizacja
|
data.employment.location | string |
lokalizacja |
|
countryOfWork
|
data.employment.countryOfWork | string |
countryOfWork |
|
globalTransferDate
|
data.employment.globalTransferDate | date |
globalTransferDate |
|
costCentre
|
data.employment.costCentre | string |
costCentre |
|
workPostCode
|
data.employment.workPostCode | string |
workPostCode |
|
numer telefonu służbowego
|
data.employment.workPhoneNumber | string |
numer telefonu służbowego |
|
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 |
|
wakacjeHours
|
data.employment.workingHours.holidayHours | integer |
wakacjeHours |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
wynagrodzenie
|
data.employment.salaryDetails.salary | double |
wynagrodzenie |
|
salaryEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | date |
salaryEffectiveDate |
|
renta rentowa
|
data.employment.salaryDetails.pensionableSalary | double |
renta rentowa |
|
payPeriods
|
data.employment.salaryDetails.payPeriods | integer |
payPeriods |
|
marketCarAllowance
|
data.employment.salaryDetails.marketCarAllowance | double |
marketCarAllowance |
|
flexFund
|
data.employment.funding.flexFund | double |
flexFund |
|
finansowanieLevel1
|
data.employment.funding.fundingLevel1 | string |
finansowanieLevel1 |
|
finansowanieLevel2
|
data.employment.funding.fundingLevel2 | string |
finansowanieLevel2 |
|
finansowanieLevel3
|
data.employment.funding.fundingLevel3 | string |
finansowanieLevel3 |
|
finansowanieLevel4
|
data.employment.funding.fundingLevel4 | string |
finansowanieLevel4 |
|
finansowanieLevel5
|
data.employment.funding.fundingLevel5 | string |
finansowanieLevel5 |
|
startDate
|
data.employment.contractDetails.startDate | date |
startDate |
|
data zakończenia
|
data.employment.contractDetails.endDate | date |
data zakończenia |
|
typ
|
data.employment.contractDetails.type | string |
typ |
|
nationalIdentityNumber1
|
data.nationalIdentity.nationalIdentityNumber1 | string |
nationalIdentityNumber1 |
|
nationalIdentityNumber2
|
data.nationalIdentity.nationalIdentityNumber2 | string |
nationalIdentityNumber2 |
|
nationalIdentityNumber3
|
data.nationalIdentity.nationalIdentityNumber3 | string |
nationalIdentityNumber3 |
|
nationalIdentityCountry
|
data.nationalIdentity.nationalIdentityCountry | string |
nationalIdentityCountry |
|
atrybuty customAttributes
|
data.customAttributes | object |
atrybuty customAttributes |
|
sygnatura czasowa
|
timestamp | date-time |
sygnatura czasowa |
Pobieranie istniejących użytkowników
Uzyskiwanie utworzonych użytkowników na platformie Benifex według identyfikatorów pracowników z obsługą stronicowania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikatory pracowników do pobrania
|
employeeIds | True | string |
Unikatowe identyfikatory pracowników używane do filtrowania użytkowników pobieranych z platformy Benifex |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
pagination.page | integer |
page |
|
size
|
pagination.size | integer |
size |
|
totalPages
|
pagination.totalPages | integer |
totalPages |
|
Łączna liczba elementów
|
pagination.totalItems | integer |
Łączna liczba elementów |
|
hasNext
|
pagination.hasNext | boolean |
hasNext |
|
hasPrevious
|
pagination.hasPrevious | boolean |
hasPrevious |
|
dane
|
data | array of object |
dane |
|
id
|
data.id | string |
id |
|
adres e-mail
|
data.emailAddress | string |
adres e-mail |
|
imię
|
data.forename | string |
imię |
|
nazwisko
|
data.surname | string |
nazwisko |
|
identyfikator pracownika
|
data.employeeId | string |
identyfikator pracownika |
|
departament
|
data.department | string |
departament |
|
tytuł stanowiska
|
data.jobTitle | string |
tytuł stanowiska |
|
lokalizacja
|
data.location | string |
lokalizacja |
|
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 |
|
sygnatura czasowa
|
timestamp | date-time |
sygnatura czasowa |
Uzyskiwanie informacji o korzyściach dla użytkowników
Zwraca szczegóły pojedynczej korzyści dla żądanego użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator użytkownika
|
user-id | True | string |
Określony identyfikator użytkownika, o którym chcesz uzyskać informacje |
|
Unikatowy identyfikator korzyści
|
benefit-key | True | string |
Określony klucz używany do identyfikowania informacji o korzyściach, które chcesz pobrać dla danego użytkownika |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
data.status | string |
stan |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
coroczny
|
data.benefitCost.annual | double |
coroczny |
|
miesięczny
|
data.benefitCost.monthly | double |
miesięczny |
|
waluta
|
data.benefitCost.currency | string |
waluta |
|
coroczny
|
data.employeeContribution.annual | double |
coroczny |
|
miesięczny
|
data.employeeContribution.monthly | double |
miesięczny |
|
waluta
|
data.employeeContribution.currency | string |
waluta |
|
coroczny
|
data.employerContribution.annual | double |
coroczny |
|
miesięczny
|
data.employerContribution.monthly | double |
miesięczny |
|
waluta
|
data.employerContribution.currency | string |
waluta |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
opis
|
data.description | string |
opis |
|
Sekcje
|
data.sections | array of object |
Sekcje |
|
title
|
data.sections.title | string |
title |
|
typ
|
data.sections.type | string |
typ |
|
zawartość
|
data.sections.content | string |
zawartość |
|
Sekcje
|
data.sections.sections | array of object |
Sekcje |
|
title
|
data.sections.sections.title | string |
title |
|
typ
|
data.sections.sections.type | string |
typ |
|
zawartość
|
data.sections.sections.content | string |
zawartość |
|
często zadawane pytania
|
data.faqs | array of object |
często zadawane pytania |
|
pytanie
|
data.faqs.question | string |
pytanie |
|
odpowiedź
|
data.faqs.answer | string |
odpowiedź |
|
needToKnow
|
data.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.usefulLinks | array of object |
usefulLinks |
|
URI
|
data.usefulLinks.uri | string |
URI |
|
linkTekst
|
data.usefulLinks.linkText | string |
linkTekst |
|
datesFormat
|
data.datesFormat | string |
datesFormat |
|
sygnatura czasowa
|
timestamp | date-time |
sygnatura czasowa |
Uzyskiwanie podsumowanych dostępnych i kwalifikujących się do dodania korzyści użytkownika
Zwraca bieżące i kwalifikujące się do dodania korzyści dla żądanego użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator użytkownika
|
user-id | True | string |
Określony identyfikator użytkownika, o którym chcesz uzyskać informacje |
|
Format odpowiedzi
|
accept | string |
Definiuje typ nośnika oczekiwany w odpowiedzi, zwykle ustawiony na wartość application/json w celu odbierania danych w formacie JSON |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
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 |
|
stan
|
data.currentBenefits.status | string |
stan |
|
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 |
|
stan
|
data.eligibleToAddBenefits.status | string |
stan |
|
sygnatura czasowa
|
timestamp | date-time |
sygnatura czasowa |
Uzyskiwanie szczegółowych dostępnych i kwalifikujących się do dodania korzyści związanych z użytkownikiem
Zwraca szczegóły bieżącego i uprawnionego do dodawania korzyści dla żądanego użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator użytkownika
|
user-id | True | string |
Określony identyfikator użytkownika, o którym chcesz uzyskać informacje |
|
Format odpowiedzi
|
accept | string |
Definiuje typ nośnika oczekiwany w odpowiedzi, zwykle ustawiony na wartość application/json w celu odbierania danych w formacie JSON |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
stan
|
data.currentBenefits.status | string |
stan |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
coroczny
|
data.currentBenefits.benefitCost.annual | double |
coroczny |
|
miesięczny
|
data.currentBenefits.benefitCost.monthly | double |
miesięczny |
|
waluta
|
data.currentBenefits.benefitCost.currency | string |
waluta |
|
coroczny
|
data.currentBenefits.employeeContribution.annual | double |
coroczny |
|
miesięczny
|
data.currentBenefits.employeeContribution.monthly | double |
miesięczny |
|
waluta
|
data.currentBenefits.employeeContribution.currency | string |
waluta |
|
coroczny
|
data.currentBenefits.employerContribution.annual | double |
coroczny |
|
miesięczny
|
data.currentBenefits.employerContribution.monthly | double |
miesięczny |
|
waluta
|
data.currentBenefits.employerContribution.currency | string |
waluta |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
opis
|
data.currentBenefits.description | string |
opis |
|
Sekcje
|
data.currentBenefits.sections | array of object |
Sekcje |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
typ
|
data.currentBenefits.sections.type | string |
typ |
|
zawartość
|
data.currentBenefits.sections.content | string |
zawartość |
|
Sekcje
|
data.currentBenefits.sections.sections | array of |
Sekcje |
|
często zadawane pytania
|
data.currentBenefits.faqs | array of object |
często zadawane pytania |
|
pytanie
|
data.currentBenefits.faqs.question | string |
pytanie |
|
odpowiedź
|
data.currentBenefits.faqs.answer | string |
odpowiedź |
|
needToKnow
|
data.currentBenefits.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.currentBenefits.usefulLinks | array of object |
usefulLinks |
|
URI
|
data.currentBenefits.usefulLinks.uri | string |
URI |
|
linkTekst
|
data.currentBenefits.usefulLinks.linkText | string |
linkTekst |
|
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 |
|
opis
|
data.eligibleToAddBenefits.description | string |
opis |
|
Sekcje
|
data.eligibleToAddBenefits.sections | array of object |
Sekcje |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
typ
|
data.eligibleToAddBenefits.sections.type | string |
typ |
|
zawartość
|
data.eligibleToAddBenefits.sections.content | string |
zawartość |
|
Sekcje
|
data.eligibleToAddBenefits.sections.sections | array of object |
Sekcje |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
typ
|
data.eligibleToAddBenefits.sections.sections.type | string |
typ |
|
zawartość
|
data.eligibleToAddBenefits.sections.sections.content | string |
zawartość |
|
często zadawane pytania
|
data.eligibleToAddBenefits.faqs | array of object |
często zadawane pytania |
|
pytanie
|
data.eligibleToAddBenefits.faqs.question | string |
pytanie |
|
odpowiedź
|
data.eligibleToAddBenefits.faqs.answer | string |
odpowiedź |
|
needToKnow
|
data.eligibleToAddBenefits.needToKnow | string |
needToKnow |
|
usefulLinks
|
data.eligibleToAddBenefits.usefulLinks | array of object |
usefulLinks |
|
URI
|
data.eligibleToAddBenefits.usefulLinks.uri | string |
URI |
|
linkTekst
|
data.eligibleToAddBenefits.usefulLinks.linkText | string |
linkTekst |
|
datesFormat
|
data.eligibleToAddBenefits.datesFormat | string |
datesFormat |
|
sygnatura czasowa
|
timestamp | date-time |
sygnatura czasowa |