Benifex (Pré-visualização)
A plataforma Benifex simplifica a gestão global de benefícios, bem-estar e recompensas dos colaboradores através de uma experiência única e unificada. Este 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 elegibilidade
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Benifex |
| URL | https://benifex.com/contact-us |
| et-noreply@benifex.com |
| Metadados do conector | |
|---|---|
| Editora | Benefex Ltd |
| Sítio Web | https://benifex.com |
| Política de privacidade | https://benifex.com/privacy-notice |
| Categorias | IA; Recursos Humanos |
Conector Benifex
A Benifex é especializada no fornecimento de tecnologia de experiência do colaborador, com foco em áreas como benefícios, bem-estar, reconhecimento e engajamento.
Temos a missão de 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.
Editora: Benifex
Pré-requisitos
Para começar, inscreva-se numa conta de programador com o seu Gestor de Sucesso do Cliente Benifex. Uma vez aprovado, você receberá um link para a seção de administração do nosso portal do desenvolvedor.
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 suportadas
- Obter usuários existentes: recupere usuários existentes por ID de funcionário. Suporta 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 atualmente disponíveis e qualificados para adicionar para um determinado usuário.
- Obter benefícios detalhados: retorna informações detalhadas sobre os benefícios atuais e elegíveis 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.
Obtenção de 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
POSTsolicitação para o URI do ponto de extremidade de token:
https://hub.onehub.global/oauth2/default/v1/tokenAdicione o
Content-Typeconjunto de cabeçalhos aapplication/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 sandbox, visite o Portal da API da Benifex.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Obtenha benefícios detalhados disponíveis e elegíveis para adicionar do usuário |
Retorna detalhes de atuais e qualificados para adicionar benefícios para o usuário solicitado |
| Obtenha benefícios resumidos, disponíveis e elegíveis para adicionar do usuário |
Retorna atual e qualificado para adicionar benefícios para o usuário solicitado |
| Obter informações sobre benefícios para o usuário |
Devolve detalhes de benefício único do utilizador solicitado |
| Obter usuário existente |
Seja criado utilizador na plataforma Benifex |
| Obter usuários existentes |
Obtenha utilizadores criados na plataforma Benifex através de IDs de funcionários com suporte de paginação |
Obtenha benefícios detalhados disponíveis e elegíveis para adicionar do usuário
Retorna detalhes de atuais e qualificados para adicionar benefícios para o usuário solicitado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo do usuário
|
user-id | True | string |
ID específico 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 em JSON |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
currentBenefícios
|
data.currentBenefits | array of object |
currentBenefícios |
|
estado
|
data.currentBenefits.status | string |
estado |
|
effectiveFrom
|
data.currentBenefits.effectiveFrom | string |
effectiveFrom |
|
editávelAté
|
data.currentBenefits.editableUntil | string |
editávelAté |
|
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 |
|
secções
|
data.currentBenefits.sections | array of object |
secções |
|
title
|
data.currentBenefits.sections.title | string |
title |
|
tipo
|
data.currentBenefits.sections.type | string |
tipo |
|
conteúdo
|
data.currentBenefits.sections.content | string |
conteúdo |
|
secções
|
data.currentBenefits.sections.sections | array of |
secções |
|
Perguntas frequentes
|
data.currentBenefits.faqs | array of object |
Perguntas frequentes |
|
pergunta
|
data.currentBenefits.faqs.question | string |
pergunta |
|
resposta
|
data.currentBenefits.faqs.answer | string |
resposta |
|
precisaSaber
|
data.currentBenefits.needToKnow | string |
precisaSaber |
|
ligações úteis
|
data.currentBenefits.usefulLinks | array of object |
ligações úteis |
|
URI
|
data.currentBenefits.usefulLinks.uri | string |
URI |
|
linkTexto
|
data.currentBenefits.usefulLinks.linkText | string |
linkTexto |
|
datasFormato
|
data.currentBenefits.datesFormat | string |
datasFormato |
|
elegívelToAddBenefits
|
data.eligibleToAddBenefits | array of object |
elegívelToAddBenefits |
|
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 |
|
secções
|
data.eligibleToAddBenefits.sections | array of object |
secções |
|
title
|
data.eligibleToAddBenefits.sections.title | string |
title |
|
tipo
|
data.eligibleToAddBenefits.sections.type | string |
tipo |
|
conteúdo
|
data.eligibleToAddBenefits.sections.content | string |
conteúdo |
|
secções
|
data.eligibleToAddBenefits.sections.sections | array of object |
secçõ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 |
|
resposta
|
data.eligibleToAddBenefits.faqs.answer | string |
resposta |
|
precisaSaber
|
data.eligibleToAddBenefits.needToKnow | string |
precisaSaber |
|
ligações úteis
|
data.eligibleToAddBenefits.usefulLinks | array of object |
ligações úteis |
|
URI
|
data.eligibleToAddBenefits.usefulLinks.uri | string |
URI |
|
linkTexto
|
data.eligibleToAddBenefits.usefulLinks.linkText | string |
linkTexto |
|
datasFormato
|
data.eligibleToAddBenefits.datesFormat | string |
datasFormato |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obtenha benefícios resumidos, disponíveis e elegíveis para adicionar do usuário
Retorna atual e qualificado para adicionar benefícios para o usuário solicitado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo do usuário
|
user-id | True | string |
ID específico 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 em JSON |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
currentBenefícios
|
data.currentBenefits | array of object |
currentBenefícios |
|
benefitKey
|
data.currentBenefits.benefitKey | string |
benefitKey |
|
title
|
data.currentBenefits.title | string |
title |
|
benefitLink
|
data.currentBenefits.benefitLink | string |
benefitLink |
|
estado
|
data.currentBenefits.status | string |
estado |
|
elegívelToAddBenefits
|
data.eligibleToAddBenefits | array of object |
elegívelToAddBenefits |
|
benefitKey
|
data.eligibleToAddBenefits.benefitKey | string |
benefitKey |
|
title
|
data.eligibleToAddBenefits.title | string |
title |
|
benefitLink
|
data.eligibleToAddBenefits.benefitLink | string |
benefitLink |
|
estado
|
data.eligibleToAddBenefits.status | string |
estado |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter informações sobre benefícios para o usuário
Devolve detalhes de benefício único do utilizador solicitado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo do usuário
|
user-id | True | string |
ID específico do usuário sobre o qual você deseja obter informações |
|
Identificador exclusivo do benefício
|
benefit-key | True | string |
Chave específica usada para identificar quais informações de benefício você deseja recuperar para determinado usuário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
data.status | string |
estado |
|
effectiveFrom
|
data.effectiveFrom | string |
effectiveFrom |
|
editávelAté
|
data.editableUntil | string |
editávelAté |
|
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 |
|
secções
|
data.sections | array of object |
secções |
|
title
|
data.sections.title | string |
title |
|
tipo
|
data.sections.type | string |
tipo |
|
conteúdo
|
data.sections.content | string |
conteúdo |
|
secções
|
data.sections.sections | array of object |
secçõ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 |
|
resposta
|
data.faqs.answer | string |
resposta |
|
precisaSaber
|
data.needToKnow | string |
precisaSaber |
|
ligações úteis
|
data.usefulLinks | array of object |
ligações úteis |
|
URI
|
data.usefulLinks.uri | string |
URI |
|
linkTexto
|
data.usefulLinks.linkText | string |
linkTexto |
|
datasFormato
|
data.datesFormat | string |
datasFormato |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter usuário existente
Seja criado utilizador na plataforma Benifex
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo do usuário
|
user-id | True | string |
ID específico do usuário sobre o qual você deseja obter informações |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
Nome próprio
|
data.forename | string |
Nome próprio |
|
Apelido
|
data.surname | string |
Apelido |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
title
|
data.title | string |
title |
|
preferredName
|
data.preferredName | string |
preferredName |
|
nome_local
|
data.localName | string |
nome_local |
|
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 |
|
código postalCEP
|
data.address.postcodeZipCode | string |
código postalCEP |
|
country
|
data.address.country | string |
country |
|
endereço de e-mail
|
data.emailAddress | string |
endereço de e-mail |
|
Género
|
data.gender | string |
Género |
|
nacionalidade
|
data.nationality | string |
nacionalidade |
|
linguagem
|
data.language | string |
linguagem |
|
Estado civil
|
data.maritalStatus | string |
Estado civil |
|
efetivaDatadeEstado Conjugal
|
data.effectiveDateOfMaritalStatus | date |
efetivaDatadeEstado Conjugal |
|
ID de funcionário
|
data.employment.employeeId | string |
ID de funcionário |
|
adicionalEmployeeId
|
data.employment.additionalEmployeeId | string |
adicionalEmployeeId |
|
startDate
|
data.employment.startDate | date |
startDate |
|
originalData de Início
|
data.employment.originalStartDate | date |
originalData de Início |
|
Liberdade condicionalData Passada
|
data.employment.probationPassedDate | date |
Liberdade condicionalData Passada |
|
aprendizStartDate
|
data.employment.apprenticeStartDate | date |
aprendizStartDate |
|
LicençaData
|
data.employment.leaveDate | date |
LicençaData |
|
rescisãoRazão
|
data.employment.terminationReason | string |
rescisãoRazão |
|
título do trabalho
|
data.employment.jobTitle | string |
título do trabalho |
|
situação laboral
|
data.employment.employmentStatus | string |
situação laboral |
|
Grau
|
data.employment.grade | string |
Grau |
|
legalEmployerCompany
|
data.employment.legalEmployerCompany | string |
legalEmployerCompany |
|
departamento
|
data.employment.department | string |
departamento |
|
Divisão
|
data.employment.division | string |
Divisão |
|
Unidade de negócio
|
data.employment.businessUnit | string |
Unidade de negócio |
|
localização
|
data.employment.location | string |
localização |
|
País de Trabalho
|
data.employment.countryOfWork | string |
País de Trabalho |
|
globalTransferDate
|
data.employment.globalTransferDate | date |
globalTransferDate |
|
Centro de Custos
|
data.employment.costCentre | string |
Centro de Custos |
|
workCódigo Postal
|
data.employment.workPostCode | string |
workCódigo Postal |
|
workPhoneNumber
|
data.employment.workPhoneNumber | string |
workPhoneNumber |
|
Horas contratadas
|
data.employment.workingHours.contractedHours | double |
Horas contratadas |
|
fullTimeEquivalentHours
|
data.employment.workingHours.fullTimeEquivalentHours | double |
fullTimeEquivalentHours |
|
diasPerWeek
|
data.employment.workingHours.daysPerWeek | integer |
diasPerWeek |
|
fullTimeEquivalentFraction
|
data.employment.workingHours.fullTimeEquivalentFraction | double |
fullTimeEquivalentFraction |
|
dias de férias
|
data.employment.workingHours.holidayDays | double |
dias de férias |
|
feriadoHoras
|
data.employment.workingHours.holidayHours | integer |
feriadoHoras |
|
payGroup
|
data.employment.salaryDetails.payGroup | string |
payGroup |
|
salário
|
data.employment.salaryDetails.salary | double |
salário |
|
salárioEfetivaData
|
data.employment.salaryDetails.salaryEffectiveDate | date |
salárioEfetivaData |
|
pensionistaSalário
|
data.employment.salaryDetails.pensionableSalary | double |
pensionistaSalário |
|
payPeríodos
|
data.employment.salaryDetails.payPeriods | integer |
payPeríodos |
|
mercadoCarAllowance
|
data.employment.salaryDetails.marketCarAllowance | double |
mercadoCarAllowance |
|
FlexFund
|
data.employment.funding.flexFund | double |
FlexFund |
|
financiamentoNível 1
|
data.employment.funding.fundingLevel1 | string |
financiamentoNível 1 |
|
financiamentoNível 2
|
data.employment.funding.fundingLevel2 | string |
financiamentoNível 2 |
|
financiamentoNível 3
|
data.employment.funding.fundingLevel3 | string |
financiamentoNível 3 |
|
financiamentoNível 4
|
data.employment.funding.fundingLevel4 | string |
financiamentoNível 4 |
|
financiamentoNível 5
|
data.employment.funding.fundingLevel5 | string |
financiamentoNível 5 |
|
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 |
|
nacionalIdentityNumber1
|
data.nationalIdentity.nationalIdentityNumber1 | string |
nacionalIdentityNumber1 |
|
nacionalIdentityNumber2
|
data.nationalIdentity.nationalIdentityNumber2 | string |
nacionalIdentityNumber2 |
|
nacionalIdentityNumber3
|
data.nationalIdentity.nationalIdentityNumber3 | string |
nacionalIdentityNumber3 |
|
nacionalIdentidadePaís
|
data.nationalIdentity.nationalIdentityCountry | string |
nacionalIdentidadePaís |
|
customAttributes
|
data.customAttributes | object |
customAttributes |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |
Obter usuários existentes
Obtenha utilizadores criados na plataforma Benifex através de IDs de funcionários com suporte de paginação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IDs de funcionários a serem recuperados
|
employeeIds | True | string |
Identificadores exclusivos de funcionários usados para filtrar os usuários que estão sendo buscados na plataforma Benifex |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
pagination.page | integer |
página |
|
size
|
pagination.size | integer |
size |
|
totalPáginas
|
pagination.totalPages | integer |
totalPáginas |
|
totalItens
|
pagination.totalItems | integer |
totalItens |
|
hasNext
|
pagination.hasNext | boolean |
hasNext |
|
temAnterior
|
pagination.hasPrevious | boolean |
temAnterior |
|
dados
|
data | array of object |
dados |
|
id
|
data.id | string |
id |
|
endereço de e-mail
|
data.emailAddress | string |
endereço de e-mail |
|
Nome próprio
|
data.forename | string |
Nome próprio |
|
Apelido
|
data.surname | string |
Apelido |
|
ID de funcionário
|
data.employeeId | string |
ID de funcionário |
|
departamento
|
data.department | string |
departamento |
|
título do trabalho
|
data.jobTitle | string |
título do trabalho |
|
localização
|
data.location | string |
localização |
|
País de Trabalho
|
data.countryOfWork | string |
País de Trabalho |
|
dateOfBirth
|
data.dateOfBirth | date |
dateOfBirth |
|
startDate
|
data.startDate | date |
startDate |
|
Unidade de negócio
|
data.businessUnit | string |
Unidade de negócio |
|
Género
|
data.gender | string |
Género |
|
carimbo de data/hora
|
timestamp | date-time |
carimbo de data/hora |