Benifex (versión preliminar)
La plataforma Benifex simplifica los beneficios globales de los empleados, el bienestar y la administración de recompensas a través de una única experiencia unificada. Este conector permite una integración perfecta con la plataforma Benifex, lo que proporciona acceso a los datos de los empleados, las selecciones de beneficios y los detalles de idoneidad.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Soporte técnico de Benifex |
| URL | https://benifex.com/contact-us |
| Correo Electrónico | et-noreply@benifex.com |
| Metadatos del conector | |
|---|---|
| Publicador | Benefex Ltd |
| Sitio web | https://benifex.com |
| Directiva de privacidad | https://benifex.com/privacy-notice |
| Categorías | IA; Recursos humanos |
Conector de Benifex
Benifex se especializa en ofrecer tecnología de experiencia de empleado, centrándose en áreas como beneficios, bienestar, reconocimiento y compromiso.
Estamos en una misión de crear experiencias extraordinarias que aman los clientes y los empleados.
El conector de Benifex permite la integración de datos con la plataforma Benifex.
Publicador: Benifex
Prerrequisitos
Para empezar, regístrese para obtener una cuenta de desarrollador con su Administrador de éxito del cliente de Benifex. Una vez aprobado, se le proporcionará un vínculo a la sección de administración de nuestro portal para desarrolladores.
También se le proporcionará con su cliente client_id único y secret. Una vez que tenga estas credenciales, podrá comunicarse con nuestras API.
Para obtener más información, consulte la guía de autenticación.
Operaciones admitidas
- Obtener usuarios existentes: recupere los usuarios existentes por identificador de empleado. Admite la paginación.
- Obtener usuario existente: recupere un usuario específico de la plataforma Benifex.
- Obtener ventajas resumidas: devuelve un resumen de las ventajas disponibles actualmente y aptas para agregar para un usuario determinado.
- Obtener ventajas detalladas: devuelve información detallada sobre las ventajas actuales y aptas para agregar para un usuario determinado.
- Obtener información sobre las ventajas del usuario: devuelve información sobre una ventaja específica para un usuario específico.
Para más información sobre estas operaciones, consulte la documentación de referencia de API.
Obtención de credenciales
Para acceder a nuestra API, deberá obtener las credenciales necesarias, tal y como se describe en la sección Requisitos previos .
Un token de acceso JWT se obtiene mediante el flujo de credenciales de cliente de OAuth 2.0.
Obtenga el token de acceso de JWT mediante la autenticación con sus credenciales.
Envíe una
POSTsolicitud al URI del punto de conexión del token:
https://hub.onehub.global/oauth2/default/v1/tokenAgregue el
Content-Typeencabezado establecido enapplication/x-www-form-urlencoded.Incluya lo siguiente en el cuerpo HTTP:
client_idclient_secretgrant_type=client_credentials
Introducción
Para obtener documentación completa, guías de implementación y pruebas de espacio aislado, visite el portal de la API de Benifex.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Obtención de información sobre las ventajas del usuario |
Devuelve los detalles de una sola ventaja del usuario solicitado. |
| Obtención de ventajas resumidas disponibles y aptas para agregar del usuario |
Devuelve las ventajas actuales y aptas para agregar ventajas para el usuario solicitado. |
| Obtener usuario existente |
Creación de un usuario en la plataforma de Benifex |
| Obtener usuarios existentes |
Obtención de usuarios creados en la plataforma Benifex por identificadores de empleado con soporte técnico de paginación |
| Obtener ventajas detalladas disponibles y aptas para agregar del usuario |
Devuelve los detalles actuales y aptos para agregar ventajas para el usuario solicitado. |
Obtención de información sobre las ventajas del usuario
Devuelve los detalles de una sola ventaja del usuario solicitado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del usuario
|
user-id | True | string |
Identificador específico del usuario que desea obtener información sobre |
|
Identificador único de la ventaja
|
benefit-key | True | string |
Clave específica que se usa para identificar la información de ventaja que desea recuperar para el usuario determinado |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
data.status | string |
estado |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
anual
|
data.benefitCost.annual | double |
anual |
|
mensual
|
data.benefitCost.monthly | double |
mensual |
|
divisa
|
data.benefitCost.currency | string |
divisa |
|
anual
|
data.employeeContribution.annual | double |
anual |
|
mensual
|
data.employeeContribution.monthly | double |
mensual |
|
divisa
|
data.employeeContribution.currency | string |
divisa |
|
anual
|
data.employerContribution.annual | double |
anual |
|
mensual
|
data.employerContribution.monthly | double |
mensual |
|
divisa
|
data.employerContribution.currency | string |
divisa |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
descripción
|
data.description | string |
descripción |
|
Secciones
|
data.sections | array of object |
Secciones |
|
title
|
data.sections.title | string |
title |
|
type
|
data.sections.type | string |
type |
|
contenido
|
data.sections.content | string |
contenido |
|
Secciones
|
data.sections.sections | array of object |
Secciones |
|
title
|
data.sections.sections.title | string |
title |
|
type
|
data.sections.sections.type | string |
type |
|
contenido
|
data.sections.sections.content | string |
contenido |
|
Preguntas más frecuentes
|
data.faqs | array of object |
Preguntas más frecuentes |
|
pregunta
|
data.faqs.question | string |
pregunta |
|
respuesta
|
data.faqs.answer | string |
respuesta |
|
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 de tiempo
|
timestamp | date-time |
marca de tiempo |
Obtención de ventajas resumidas disponibles y aptas para agregar del usuario
Devuelve las ventajas actuales y aptas para agregar ventajas para el usuario solicitado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del usuario
|
user-id | True | string |
Identificador específico del usuario que desea obtener información sobre |
|
Formato de respuesta
|
accept | string |
Define el tipo de medio esperado en la respuesta, normalmente establecido en application/json para recibir datos con formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | 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 |
|
estado
|
data.currentBenefits.status | string |
estado |
|
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 |
|
estado
|
data.eligibleToAddBenefits.status | string |
estado |
|
marca de tiempo
|
timestamp | date-time |
marca de tiempo |
Obtener usuario existente
Creación de un usuario en la plataforma de Benifex
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del usuario
|
user-id | True | string |
Identificador específico del usuario que desea obtener información sobre |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
nombre de pila
|
data.forename | string |
nombre de pila |
|
apellido
|
data.surname | string |
apellido |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
número de teléfono
|
data.phoneNumber | string |
número de teléfono |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
línea 3
|
data.address.line3 | string |
línea 3 |
|
línea 4
|
data.address.line4 | string |
línea 4 |
|
line5
|
data.address.line5 | string |
line5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
dirección de correo electrónico
|
data.emailAddress | string |
dirección de correo electrónico |
|
gender
|
data.gender | string |
gender |
|
nacionalidad
|
data.nationality | string |
nacionalidad |
|
lenguaje
|
data.language | string |
lenguaje |
|
mariStatus
|
data.maritalStatus | string |
mariStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
ID de empleado
|
data.employment.employeeId | string |
ID de empleado |
|
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 |
|
título del trabajo
|
data.employment.jobTitle | string |
título del trabajo |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
grade
|
data.employment.grade | string |
grade |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
departamento
|
data.employment.department | string |
departamento |
|
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 |
|
sueldo
|
data.employment.salaryDetails.salary | double |
sueldo |
|
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 |
|
startDate
|
data.employment.contractDetails.startDate | date |
startDate |
|
fecha de finalización
|
data.employment.contractDetails.endDate | date |
fecha de finalización |
|
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 |
|
marca de tiempo
|
timestamp | date-time |
marca de tiempo |
Obtener usuarios existentes
Obtención de usuarios creados en la plataforma Benifex por identificadores de empleado con soporte técnico de paginación
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de empleado que se van a recuperar
|
employeeIds | True | string |
Identificadores de empleados únicos usados para filtrar los usuarios que se capturan desde la plataforma de Benifex |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
pagination.page | integer |
página |
|
size
|
pagination.size | integer |
size |
|
totalPages
|
pagination.totalPages | integer |
totalPages |
|
total de elementos
|
pagination.totalItems | integer |
total de elementos |
|
hasNext
|
pagination.hasNext | boolean |
hasNext |
|
hasPrevious
|
pagination.hasPrevious | boolean |
hasPrevious |
|
datos
|
data | array of object |
datos |
|
id
|
data.id | string |
id |
|
dirección de correo electrónico
|
data.emailAddress | string |
dirección de correo electrónico |
|
nombre de pila
|
data.forename | string |
nombre de pila |
|
apellido
|
data.surname | string |
apellido |
|
ID de empleado
|
data.employeeId | string |
ID de empleado |
|
departamento
|
data.department | string |
departamento |
|
título del trabajo
|
data.jobTitle | string |
título del trabajo |
|
location
|
data.location | string |
location |
|
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 |
|
marca de tiempo
|
timestamp | date-time |
marca de tiempo |
Obtener ventajas detalladas disponibles y aptas para agregar del usuario
Devuelve los detalles actuales y aptos para agregar ventajas para el usuario solicitado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del usuario
|
user-id | True | string |
Identificador específico del usuario que desea obtener información sobre |
|
Formato de respuesta
|
accept | string |
Define el tipo de medio esperado en la respuesta, normalmente establecido en application/json para recibir datos con formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
currentBenefits
|
data.currentBenefits | array of object |
currentBenefits |
|
estado
|
data.currentBenefits.status | string |
estado |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.currentBenefits.editableUntil | string |
editableUntil |
|
changeDate
|
data.currentBenefits.changeDate | string |
changeDate |
|
anual
|
data.currentBenefits.benefitCost.annual | double |
anual |
|
mensual
|
data.currentBenefits.benefitCost.monthly | double |
mensual |
|
divisa
|
data.currentBenefits.benefitCost.currency | string |
divisa |
|
anual
|
data.currentBenefits.employeeContribution.annual | double |
anual |
|
mensual
|
data.currentBenefits.employeeContribution.monthly | double |
mensual |
|
divisa
|
data.currentBenefits.employeeContribution.currency | string |
divisa |
|
anual
|
data.currentBenefits.employerContribution.annual | double |
anual |
|
mensual
|
data.currentBenefits.employerContribution.monthly | double |
mensual |
|
divisa
|
data.currentBenefits.employerContribution.currency | string |
divisa |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
descripción
|
data.currentBenefits.description | string |
descripción |
|
Secciones
|
data.currentBenefits.sections | array of object |
Secciones |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
type
|
data.currentBenefits.sections.type | string |
type |
|
contenido
|
data.currentBenefits.sections.content | string |
contenido |
|
Secciones
|
data.currentBenefits.sections.sections | array of |
Secciones |
|
Preguntas más frecuentes
|
data.currentBenefits.faqs | array of object |
Preguntas más frecuentes |
|
pregunta
|
data.currentBenefits.faqs.question | string |
pregunta |
|
respuesta
|
data.currentBenefits.faqs.answer | string |
respuesta |
|
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 |
|
descripción
|
data.eligibleToAddBenefits.description | string |
descripción |
|
Secciones
|
data.eligibleToAddBenefits.sections | array of object |
Secciones |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.type | string |
type |
|
contenido
|
data.eligibleToAddBenefits.sections.content | string |
contenido |
|
Secciones
|
data.eligibleToAddBenefits.sections.sections | array of object |
Secciones |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
type
|
data.eligibleToAddBenefits.sections.sections.type | string |
type |
|
contenido
|
data.eligibleToAddBenefits.sections.sections.content | string |
contenido |
|
Preguntas más frecuentes
|
data.eligibleToAddBenefits.faqs | array of object |
Preguntas más frecuentes |
|
pregunta
|
data.eligibleToAddBenefits.faqs.question | string |
pregunta |
|
respuesta
|
data.eligibleToAddBenefits.faqs.answer | string |
respuesta |
|
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 de tiempo
|
timestamp | date-time |
marca de tiempo |