Benifex (versão prévia)
A plataforma Benifex simplifica os benefícios globais dos funcionários, o bem-estar e o gerenciamento de recompensas por meio de uma única experiência unificada. Esse conector permite uma integração perfeita com a plataforma Benifex, fornecendo acesso a dados de funcionários, seleções de benefícios e detalhes de qualificação
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Benifex |
| URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Metadados do conector | |
|---|---|
| Publicador | Benefex Ltd |
| Site | https://benifex.com |
| Política de privacidade | https://benifex.com/privacy-notice |
| Categorias | IA; Recursos humanos |
Benifex Connector
A Benifex é especializada em fornecer tecnologia de experiência dos funcionários, com foco em áreas como benefícios, bem-estar, reconhecimento e engajamento.
Estamos em uma missão para construir experiências notáveis que os clientes e funcionários adoram.
O conector Benifex permite a integração de dados com a plataforma Benifex.
Publicador: Benifex
Pré-requisitos
Para começar, inscreva-se em uma conta de desenvolvedor com o Benifex Customer Success Manager. Depois de aprovado, você receberá um link para a seção de administrador do nosso portal de desenvolvedores.
Você também será fornecido com seu cliente client_id exclusivo e secret. Depois de ter essas credenciais, você poderá se comunicar com nossas APIs.
Para obter mais detalhes, consulte o guia de Autenticação.
Operações com suporte
- Obter usuários existentes: recuperar usuários existentes por ID do funcionário. Dá suporte à paginação.
- Obter usuário existente: recupere um usuário específico da plataforma Benifex.
- Obter benefícios resumidos: retorna um resumo dos benefícios disponíveis no momento e qualificados para adicionar para um determinado usuário.
- Obter benefícios detalhados: retorna informações detalhadas sobre os benefícios atuais e qualificados para adicionar para um determinado usuário.
- Obter informações de benefício do usuário: retorna informações sobre um benefício específico para um usuário específico.
Para obter mais detalhes sobre essas operações, consulte a documentação de referência da API.
Obtendo credenciais
Para acessar nossa API, você precisará obter as credenciais necessárias, conforme descrito na seção Pré-requisitos .
Um token de acesso JWT é obtido usando o fluxo de Credenciais do Cliente OAuth 2.0.
Obtenha seu token de acesso JWT autenticando-se com suas credenciais.
Envie uma solicitação
POSTpara o URI do ponto de extremidade do token:
https://hub.onehub.global/oauth2/default/v1/tokenAdicione o
Content-Typecabeçalho definido comoapplication/x-www-form-urlencoded.Inclua o seguinte no corpo HTTP:
client_idclient_secretgrant_type=client_credentials
Introdução
Para obter documentação completa, guias de implementação e testes de área restrita, visite o Portal de API do Benifex.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Obter benefícios detalhados disponíveis e qualificados para adicionar do usuário |
Retorna detalhes do atual e qualificado para adicionar benefícios para o usuário solicitado |
| Obter benefícios resumidos disponíveis e qualificados para adicionar do usuário |
Retorna atual e qualificado para adicionar benefícios para o usuário solicitado |
| Obter informações de benefício do usuário |
Retorna detalhes do benefício único do usuário solicitado |
| Obter usuário existente |
Obter um usuário criado na plataforma Benifex |
| Obter usuários existentes |
Obter usuários criados na plataforma Benifex por IDs de funcionários com suporte para paginação |
Obter benefícios detalhados disponíveis e qualificados para adicionar do usuário
Retorna detalhes do atual e qualificado para adicionar benefícios para o usuário solicitado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do usuário
|
user-id | True | string |
ID específica do usuário sobre o qual você deseja obter informações |
|
Formato da resposta
|
accept | string |
Define o tipo de mídia esperado na resposta, geralmente definido como application/json para receber dados formatados por JSON |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 |
|
anual
|
data.currentBenefits.benefitCost.annual | double |
anual |
|
mensal
|
data.currentBenefits.benefitCost.monthly | double |
mensal |
|
moeda
|
data.currentBenefits.benefitCost.currency | string |
moeda |
|
anual
|
data.currentBenefits.employeeContribution.annual | double |
anual |
|
mensal
|
data.currentBenefits.employeeContribution.monthly | double |
mensal |
|
moeda
|
data.currentBenefits.employeeContribution.currency | string |
moeda |
|
anual
|
data.currentBenefits.employerContribution.annual | double |
anual |
|
mensal
|
data.currentBenefits.employerContribution.monthly | double |
mensal |
|
moeda
|
data.currentBenefits.employerContribution.currency | string |
moeda |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
descrição
|
data.currentBenefits.description | string |
descrição |
|
Seções
|
data.currentBenefits.sections | array of object |
Seções |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
tipo
|
data.currentBenefits.sections.type | string |
tipo |
|
conteúdo
|
data.currentBenefits.sections.content | string |
conteúdo |
|
Seções
|
data.currentBenefits.sections.sections | array of |
Seções |
|
perguntas frequentes
|
data.currentBenefits.faqs | array of object |
perguntas frequentes |
|
pergunta
|
data.currentBenefits.faqs.question | string |
pergunta |
|
responder
|
data.currentBenefits.faqs.answer | string |
responder |
|
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 |
|
descrição
|
data.eligibleToAddBenefits.description | string |
descrição |
|
Seções
|
data.eligibleToAddBenefits.sections | array of object |
Seções |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
tipo
|
data.eligibleToAddBenefits.sections.type | string |
tipo |
|
conteúdo
|
data.eligibleToAddBenefits.sections.content | string |
conteúdo |
|
Seções
|
data.eligibleToAddBenefits.sections.sections | array of object |
Seções |
|
title
|
data.eligibleToAddBenefits.sections.sections.title | string |
title |
|
tipo
|
data.eligibleToAddBenefits.sections.sections.type | string |
tipo |
|
conteúdo
|
data.eligibleToAddBenefits.sections.sections.content | string |
conteúdo |
|
perguntas frequentes
|
data.eligibleToAddBenefits.faqs | array of object |
perguntas frequentes |
|
pergunta
|
data.eligibleToAddBenefits.faqs.question | string |
pergunta |
|
responder
|
data.eligibleToAddBenefits.faqs.answer | string |
responder |
|
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 |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter benefícios resumidos disponíveis e qualificados para adicionar do usuário
Retorna atual e qualificado para adicionar benefícios para o usuário solicitado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do usuário
|
user-id | True | string |
ID específica do usuário sobre o qual você deseja obter informações |
|
Formato da resposta
|
accept | string |
Define o tipo de mídia esperado na resposta, geralmente definido como application/json para receber dados formatados por JSON |
Retornos
| Nome | Caminho | 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 |
|
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 |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter informações de benefício do usuário
Retorna detalhes do benefício único do usuário solicitado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do usuário
|
user-id | True | string |
ID específica do usuário sobre o qual você deseja obter informações |
|
Identificador de benefício exclusivo
|
benefit-key | True | string |
Chave específica usada para identificar quais informações de benefício você deseja recuperar para o usuário fornecido |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
data.status | string |
status |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editableUntil
|
data.editableUntil | string |
editableUntil |
|
changeDate
|
data.changeDate | string |
changeDate |
|
anual
|
data.benefitCost.annual | double |
anual |
|
mensal
|
data.benefitCost.monthly | double |
mensal |
|
moeda
|
data.benefitCost.currency | string |
moeda |
|
anual
|
data.employeeContribution.annual | double |
anual |
|
mensal
|
data.employeeContribution.monthly | double |
mensal |
|
moeda
|
data.employeeContribution.currency | string |
moeda |
|
anual
|
data.employerContribution.annual | double |
anual |
|
mensal
|
data.employerContribution.monthly | double |
mensal |
|
moeda
|
data.employerContribution.currency | string |
moeda |
|
benefitKey
|
data.benefitKey | string |
benefitKey |
|
title
|
data.title | string |
title |
|
benefitLink
|
data.benefitLink | string |
benefitLink |
|
descrição
|
data.description | string |
descrição |
|
Seções
|
data.sections | array of object |
Seções |
|
title
|
data.sections.title | string |
title |
|
tipo
|
data.sections.type | string |
tipo |
|
conteúdo
|
data.sections.content | string |
conteúdo |
|
Seções
|
data.sections.sections | array of object |
Seções |
|
title
|
data.sections.sections.title | string |
title |
|
tipo
|
data.sections.sections.type | string |
tipo |
|
conteúdo
|
data.sections.sections.content | string |
conteúdo |
|
perguntas frequentes
|
data.faqs | array of object |
perguntas frequentes |
|
pergunta
|
data.faqs.question | string |
pergunta |
|
responder
|
data.faqs.answer | string |
responder |
|
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 |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter usuário existente
Obter um usuário criado na plataforma Benifex
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do usuário
|
user-id | True | string |
ID específica do usuário sobre o qual você deseja obter informações |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
primeiro nome
|
data.forename | string |
primeiro nome |
|
surname
|
data.surname | string |
surname |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
localName
|
data.localName | string |
localName |
|
número de telefone
|
data.phoneNumber | string |
número de telefone |
|
line1
|
data.address.line1 | string |
line1 |
|
line2
|
data.address.line2 | string |
line2 |
|
linha3
|
data.address.line3 | string |
linha3 |
|
linha4
|
data.address.line4 | string |
linha4 |
|
linha5
|
data.address.line5 | string |
linha5 |
|
postcodeZipCode
|
data.address.postcodeZipCode | string |
postcodeZipCode |
|
country
|
data.address.country | string |
country |
|
endereço de email
|
data.emailAddress | string |
endereço de email |
|
gender
|
data.gender | string |
gender |
|
nacionalidade
|
data.nationality | string |
nacionalidade |
|
linguagem
|
data.language | string |
linguagem |
|
maritalStatus
|
data.maritalStatus | string |
maritalStatus |
|
effectiveDateOfMaritalStatus
|
data.effectiveDateOfMaritalStatus | date |
effectiveDateOfMaritalStatus |
|
identificação do funcionário
|
data.employment.employeeId | string |
identificação do funcionário |
|
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 do cargo
|
data.employment.jobTitle | string |
título do cargo |
|
employmentStatus
|
data.employment.employmentStatus | string |
employmentStatus |
|
grade
|
data.employment.grade | string |
grade |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
departamento
|
data.employment.department | string |
departamento |
|
divisão
|
data.employment.division | string |
divisão |
|
businessUnit
|
data.employment.businessUnit | string |
businessUnit |
|
local
|
data.employment.location | string |
local |
|
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 |
|
salário
|
data.employment.salaryDetails.salary | double |
salário |
|
wageEffectiveDate
|
data.employment.salaryDetails.salaryEffectiveDate | date |
wageEffectiveDate |
|
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 |
|
data de término
|
data.employment.contractDetails.endDate | date |
data de término |
|
tipo
|
data.employment.contractDetails.type | string |
tipo |
|
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 |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter usuários existentes
Obter usuários criados na plataforma Benifex por IDs de funcionários com suporte para paginação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de funcionário a serem recuperadas
|
employeeIds | True | string |
Identificadores de funcionários exclusivos usados para filtrar os usuários que estão sendo buscados da plataforma Benifex |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
pagination.page | integer |
página |
|
size
|
pagination.size | integer |
size |
|
totalPages
|
pagination.totalPages | integer |
totalPages |
|
totalItems
|
pagination.totalItems | integer |
totalItems |
|
hasNext
|
pagination.hasNext | boolean |
hasNext |
|
hasPrevious
|
pagination.hasPrevious | boolean |
hasPrevious |
|
dados
|
data | array of object |
dados |
|
id
|
data.id | string |
id |
|
endereço de email
|
data.emailAddress | string |
endereço de email |
|
primeiro nome
|
data.forename | string |
primeiro nome |
|
surname
|
data.surname | string |
surname |
|
identificação do funcionário
|
data.employeeId | string |
identificação do funcionário |
|
departamento
|
data.department | string |
departamento |
|
título do cargo
|
data.jobTitle | string |
título do cargo |
|
local
|
data.location | string |
local |
|
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 |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |