Benifex (предварительная версия)
Платформа Benifex упрощает глобальные преимущества сотрудников, благополучие и управление вознаграждениями с помощью единого единого интерфейса. Этот соединитель обеспечивает простую интеграцию с платформой Benifex, предоставляя доступ к данным сотрудников, выбору преимуществ и сведения о правах
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: - Azure Government регионы - Azure регионы Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка Benifex |
| URL | https://benifex.com/contact-us |
| Адрес электронной почты | et-noreply@benifex.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Benefex Ltd |
| Веб-сайт | https://benifex.com |
| Политика конфиденциальности | https://benifex.com/privacy-notice |
| Категории | Искусственный интеллект; Кадровые ресурсы |
Соединитель Benifex
Benifex специализируется на предоставлении технологии опыта сотрудников, акцентируя внимание на таких областях, как преимущества, благополучие, признание и участие.
Мы работаем над созданием замечательных возможностей, которые любят клиенты и сотрудники.
Соединитель Benifex обеспечивает интеграцию данных с платформой Benifex.
Издатель: Benifex
Предпосылки
Чтобы приступить к работе, зарегистрируйтесь в учетной записи разработчика с помощью диспетчера успеха клиентов Benifex. После утверждения вы получите ссылку на раздел администратора портала разработчика.
Вы также будете предоставлены уникальным клиентом client_id и secret. После получения этих учетных данных вы сможете взаимодействовать с нашими API.
Дополнительные сведения см. в руководстве по проверке подлинности.
Поддерживаемые операции
- Получение пользователя. Получение сведений о пользователе, прошедших проверку подлинности, из платформы Benifex.
- Получение суммарных преимуществ. Возвращает сводку доступных и доступных преимуществ для пользователей, прошедших проверку подлинности.
- Получение подробных преимуществ. Возвращает подробные сведения о текущих и допустимых преимуществах для пользователя, прошедшего проверку подлинности.
- Получение сведений о преимуществах пользователя: возвращает сведения о конкретном преимуществе для прошедшего проверку подлинности пользователя.
Дополнительные сведения об этих операциях см. в справочной документации по API.
Получение учетных данных
Чтобы получить доступ к нашему API, необходимо получить необходимые учетные данные, как описано в разделе "Предварительные требования ".
Маркер доступа JWT получается с помощью потока учетных данных клиента OAuth 2.0.
Получите маркер доступа JWT, выполнив проверку подлинности с помощью учетных данных.
Отправьте запрос в URI конечной
POSTточки маркера:
https://auth.onehub.dev/auth/realms/default/protocol/openid-connect/tokenДобавьте в нее набор
Content-Typeзаголовковapplication/x-www-form-urlencoded.Включите следующие элементы в текст HTTP:
client_idclient_secretgrant_type=client_credentials
Начало работы
Полные сведения о документации, руководствах по реализации и тестировании песочницы см. на портале API Benifex.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Получение кратких сведений о доступных и доступных преимуществах для добавления пользователей |
Возвращает текущие и допустимые возможности для добавления преимуществ для прошедшего проверку подлинности пользователя |
| Получение подробных доступных и доступных преимуществ для добавления пользователей |
Возвращает сведения о текущем и допустимом добавлении преимуществ для прошедшего проверку подлинности пользователя |
| Получение сведений о пользователе |
Получите сведения о пользователе, прошедшем проверку подлинности. |
| Получение сведений о преимуществах пользователя |
Возвращает сведения об одном преимуществе пользователя, прошедшего проверку подлинности. |
Получение кратких сведений о доступных и доступных преимуществах для добавления пользователей
Возвращает текущие и допустимые возможности для добавления преимуществ для прошедшего проверку подлинности пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор запроса
|
X-Client-Request-Id | string |
Идентификатор, который однозначно идентифицирует запрос. При добавлении это поможет любой отладке запросов и может использоваться для проверок идемпотентности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
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 |
|
статус
|
data.currentBenefits.status | string |
статус |
|
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 |
|
статус
|
data.eligibleToAddBenefits.status | string |
статус |
|
отметка времени
|
timestamp | date-time |
отметка времени |
Получение подробных доступных и доступных преимуществ для добавления пользователей
Возвращает сведения о текущем и допустимом добавлении преимуществ для прошедшего проверку подлинности пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор запроса
|
X-Client-Request-Id | string |
Идентификатор, который однозначно идентифицирует запрос. При добавлении это поможет любой отладке запросов и может использоваться для проверок идемпотентности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
статус
|
data.currentBenefits.status | string |
статус |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
ежегодный
|
data.currentBenefits.benefitCost.annual | double |
ежегодный |
|
ежемесячный
|
data.currentBenefits.benefitCost.monthly | double |
ежемесячный |
|
currency
|
data.currentBenefits.benefitCost.currency | string |
currency |
|
ежегодный
|
data.currentBenefits.employeeContribution.annual | double |
ежегодный |
|
ежемесячный
|
data.currentBenefits.employeeContribution.monthly | double |
ежемесячный |
|
currency
|
data.currentBenefits.employeeContribution.currency | string |
currency |
|
ежегодный
|
data.currentBenefits.employerContribution.annual | double |
ежегодный |
|
ежемесячный
|
data.currentBenefits.employerContribution.monthly | double |
ежемесячный |
|
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 |
|
описание
|
data.currentBenefits.description | string |
описание |
|
сортовое железо
|
data.currentBenefits.sections | array of object |
сортовое железо |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
содержимое
|
data.currentBenefits.sections.content | string |
содержимое |
|
сортовое железо
|
data.currentBenefits.sections.sections | array of object |
сортовое железо |
|
title
|
data.currentBenefits.sections.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.sections.type | string |
type |
|
содержимое
|
data.currentBenefits.sections.sections.content | string |
содержимое |
|
вопросы и ответы
|
data.currentBenefits.faqs | array of object |
вопросы и ответы |
|
вопрос
|
data.currentBenefits.faqs.question | string |
вопрос |
|
ответ
|
data.currentBenefits.faqs.answer | string |
ответ |
|
needToKnow
|
data.currentBenefits.needToKnow | string |
needToKnow |
|
полезные ссылки
|
data.currentBenefits.usefulLinks | array of object |
полезные ссылки |
|
УРИ
|
data.currentBenefits.usefulLinks.uri | string |
УРИ |
|
linkText
|
data.currentBenefits.usefulLinks.linkText | string |
linkText |
|
dateFormat
|
data.currentBenefits.datesFormat | string |
dateFormat |
|
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 |
|
описание
|
data.eligibleToAddBenefits.description | string |
описание |
|
сортовое железо
|
data.eligibleToAddBenefits.sections | array of object |
сортовое железо |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
содержимое
|
data.eligibleToAddBenefits.sections.content | string |
содержимое |
|
сортовое железо
|
data.eligibleToAddBenefits.sections.sections | array of object |
сортовое железо |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.type | string |
type |
|
содержимое
|
data.eligibleToAddBenefits.sections.sections.content | string |
содержимое |
|
сортовое железо
|
data.eligibleToAddBenefits.sections.sections.sections | array of object |
сортовое железо |
|
title
|
data.eligibleToAddBenefits.sections.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.sections.type | string |
type |
|
содержимое
|
data.eligibleToAddBenefits.sections.sections.sections.content | string |
содержимое |
|
вопросы и ответы
|
data.eligibleToAddBenefits.faqs | array of object |
вопросы и ответы |
|
вопрос
|
data.eligibleToAddBenefits.faqs.question | string |
вопрос |
|
ответ
|
data.eligibleToAddBenefits.faqs.answer | string |
ответ |
|
needToKnow
|
data.eligibleToAddBenefits.needToKnow | string |
needToKnow |
|
полезные ссылки
|
data.eligibleToAddBenefits.usefulLinks | array of object |
полезные ссылки |
|
УРИ
|
data.eligibleToAddBenefits.usefulLinks.uri | string |
УРИ |
|
linkText
|
data.eligibleToAddBenefits.usefulLinks.linkText | string |
linkText |
|
dateFormat
|
data.eligibleToAddBenefits.datesFormat | string |
dateFormat |
|
отметка времени
|
timestamp | date-time |
отметка времени |
Получение сведений о пользователе
Получите сведения о пользователе, прошедшем проверку подлинности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор запроса
|
X-Client-Request-Id | string |
Идентификатор, который однозначно идентифицирует запрос. При добавлении это поможет любой отладке запросов и может использоваться для проверок идемпотентности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
имя
|
data.forename | string |
имя |
|
фамилия
|
data.surname | string |
фамилия |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName;
|
data.preferredName | string |
preferredName; |
|
localName
|
data.localName | string |
localName |
|
номер телефона
|
data.phoneNumber | string |
номер телефона |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
строка 3
|
data.address.line3 | string |
строка 3 |
|
строка 4
|
data.address.line4 | string |
строка 4 |
|
line5
|
data.address.line5 | string |
line5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
адрес электронной почты
|
data.emailAddress | string |
адрес электронной почты |
|
gender
|
data.gender | string |
gender |
|
национальность
|
data.nationality | string |
национальность |
|
language
|
data.language | string |
language |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
ID сотрудника
|
data.employment.employeeId | string |
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 |
|
УченикStartDate
|
data.employment.apprenticeStartDate | date |
УченикStartDate |
|
Название должности
|
data.employment.jobTitle | string |
Название должности |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
оценка
|
data.employment.grade | string |
оценка |
|
legalEmployerCompanyy
|
data.employment.legalEmployerCompany | string |
legalEmployerCompanyy |
|
отдел
|
data.employment.department | string |
отдел |
|
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 |
|
startDate
|
data.employment.contractDetails.startDate | date |
startDate |
|
Дата окончания
|
data.employment.contractDetails.endDate | date |
Дата окончания |
|
type
|
data.employment.contractDetails.type | string |
type |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
зарплата
|
data.employment.salaryDetails.salary | double |
зарплата |
|
зарплатаEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | date |
зарплатаEffectiveDate |
|
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 |
|
финансированиеLevel4
|
data.employment.funding.fundingLevel4 | string |
финансированиеLevel4 |
|
fundingLevel5
|
data.employment.funding.fundingLevel5 | string |
fundingLevel5 |
|
leaveDate
|
data.employment.leaveDate | date |
leaveDate |
|
завершениеreason
|
data.employment.terminationReason | string |
завершениеreason |
|
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 |
|
отметка времени
|
timestamp | date-time |
отметка времени |
Получение сведений о преимуществах пользователя
Возвращает сведения об одном преимуществе пользователя, прошедшего проверку подлинности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор запроса
|
X-Client-Request-Id | string |
Идентификатор, который однозначно идентифицирует запрос. При добавлении это поможет любой отладке запросов и может использоваться для проверок идемпотентности. |
|
|
Уникальный идентификатор преимущества
|
benefit-key | True | string |
Определенный ключ, используемый для определения сведений о преимуществах, которые требуется получить для данного пользователя |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
data.status | string |
статус |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
ежегодный
|
data.benefitCost.annual | double |
ежегодный |
|
ежемесячный
|
data.benefitCost.monthly | double |
ежемесячный |
|
currency
|
data.benefitCost.currency | string |
currency |
|
ежегодный
|
data.employeeContribution.annual | double |
ежегодный |
|
ежемесячный
|
data.employeeContribution.monthly | double |
ежемесячный |
|
currency
|
data.employeeContribution.currency | string |
currency |
|
ежегодный
|
data.employerContribution.annual | double |
ежегодный |
|
ежемесячный
|
data.employerContribution.monthly | double |
ежемесячный |
|
currency
|
data.employerContribution.currency | string |
currency |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
описание
|
data.description | string |
описание |
|
сортовое железо
|
data.sections | array of object |
сортовое железо |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
содержимое
|
data.sections.content | string |
содержимое |
|
сортовое железо
|
data.sections.sections | array of object |
сортовое железо |
|
title
|
data.sections.sections.title | string |
title |
|
type
|
data.sections.sections.type | string |
type |
|
содержимое
|
data.sections.sections.content | string |
содержимое |
|
вопросы и ответы
|
data.faqs | array of object |
вопросы и ответы |
|
вопрос
|
data.faqs.question | string |
вопрос |
|
ответ
|
data.faqs.answer | string |
ответ |
|
needToKnow
|
data.needToKnow | string |
needToKnow |
|
полезные ссылки
|
data.usefulLinks | array of object |
полезные ссылки |
|
УРИ
|
data.usefulLinks.uri | string |
УРИ |
|
linkText
|
data.usefulLinks.linkText | string |
linkText |
|
dateFormat
|
data.datesFormat | string |
dateFormat |
|
отметка времени
|
timestamp | date-time |
отметка времени |