Histórico da Página
INTEGRAÇÃO GPEA003API - Serviço genérico para retorno das informações de coparticipação dos beneficiários referente aos benefícios a eles vinculados.
Contexto de negócio (Introdução)
Cada vez mais o mercado exige que as operações complexas e manipulação de dados ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas inovações e prestadores de serviços no ramo de benefícios para administrar dentro do RH, empresas e softwares especialistas na administração de benefícios estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface para que possibilite automatizar possibilitar a automatização e o envio dos dados que hoje são realizados manualmente do ERP para o softwares especialista, seja feito através de uma interface de integração.
Sistemas Envolvidos
- Protheus (módulo Gestão de Pessoal): Módulo responsável pela gestão dos dados dos funcionários, folha de pagamento e dentre outros cadastros pertinentes aos colaboradores.
- DIVICOM (Sistema Especialista): Empresa com ampla experiência em gestão de benefícios, sendo pioneira na Administração de benefícios e com atuação no mercado desde 1996 tendo atendido mais de 1.000.000 de clientes.(Dados extraídos do site do próprio parceiro,mais informações).
Integração
O objetivo desta integração é permitir que a área do RH ou a área responsável pelos benefícios, envie os dados de funcionários coparticipações para o sistema da DIVICOM e assim redução no reduzir o trabalho de inclusão manual de todas as informações dentro do sistema.
- Benefícios
- Normalmente o colaborador responsável ou empresa de benefícios, incluir inclui as informações dos funcionários das coparticipações através de um arquivo (csv, txt) ou até mesmo manualmente, com a interface de integração isso será feito de forma forma automática.
- Não terá um investimento alto de tempo para o cadastramento, pois os dados já serão enviados através da integração a cada requisição do sistema especialista.
- Arquitetura (Tecnologia)
- Toda integração entre o Protheus e o Sistema é feita por intermédio de comunicação direta com os Web Services(que são fixos) REST(Representation State Transfer) utilizando o formato JSON(JavaScript Object Notation) de serialização de dados, onde através da ativação do serviço do REST do Protheus esteja disponível para utilizar o serviço.
- Premissas e Propriedades
- O parceiro que será responsável pela requisição e transformação da informação recebida;
- Cada produto deverá gerar um LOG de inclusão(RA_USERLGI) e alteração(RA_USERLGA) de registros a fim de controlar os dados a serem integrados;
- Na requisição, o parceiro deverá informar através do preenchimento do parâmetro datemodified e se desejar uma carga completa(deixar o parâmetro vazio) ou somente os dados que foram atualizados(Informando a data de alteração). pertencem ao período informado. Caso seja solicitada a carga, todos os dados deverão ser enviados novamente. Caso seja solicitado uma atualizaçãoa data seja informada, somente os dados com data igual ou posterior pertinente a data informada, serão transmitidos;
- A data de alteração do registro deverá ser enviada em cada processofiltro(datemodified) será informada a cada requisição, permitindo que o solicitante possa controlar essa informação;
- Será implementado um controle de paginação a fim de facilitar o envio da informação para o solicitante. Neste processo o solicitante deverá informar qual é o tamanho da informação solicitada e qual página ela solicita;
- Cabe a integração informar se existem mais páginas a serem solicitadas;
Escopo
Por intermédio desta integração será disponibilizada a seguinte funcionalidade:
- Consulta de funcionárioscoparticipações;
Fora do escopo
- Automatização de Cadastramento de funcionáriosCoparticipações.
- O serviço de disponibilização de dados de Funcionário coparticipações apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante;
Pré-requisitos instalação/implantação/utilização
- Versões mínima do Protheus: 12.1.25
- Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação Protheus que faça uso da mesma.
- Estrutura de rede estável, para que haja trafego de dados sem interrupção
- Protheus devidamente configurado e serviço Rest habilitado em seu server.
Ativação/Desativação da integração
Por padrão esta integração estará em repositório, porém demanda realizar a devida configuração conforme abaixo:
- Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)
Controle de Ambiente
Exige que os seguintes pontos sejam revisados:
- Protheus com sua arquitetura devidamente estruturada.
- Módulo Gestão de Pessoal com seu cadastro de funcionário coparticipações devidamente cadastrado.
Controle de Versão
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
Suporte
O suporte aos recursos da Integração será de responsabilidade da linha MicroSiga Protheus, onde será analisada pela equipe de suporte da Totvs.
Fluxo das Informações
Esta integração traz a funcionalidade exclusivamente de cadastro de funcionáriosde coparticipação
Cadastro
Esta integração contempla apenas a consulta e envio dos dados de do cadastro de funcionárioscoparticipação.
Processos
A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de funcionários coparticipações e retornar um conjunto de informações pertinentes ao Cadastro de Funcionário(GPEA010) Coparticipação e retornar os dados para o requisitante.
Limitações / Restrições Gerais
- A integração não contemplará inclusão,alteração e exclusão de registros no Protheus, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.
- Cada produto deverá gerar um LOG de inclusão e alteração de registros a fim de controlar os dados a serem integrados;
- A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;
Como realizar a chamada da Como realizar a chamada da API REST
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos funcionários desejadosdas coparticipações desejadas.
- Preenchimento do EndPoint da API GPEA010API GPEA003API;
- Utilizar a chamada do método Get e do Serviço employeedatacontent BeneficiariesCoparticipation;
- Preenchimento dos parâmetros obrigatórios da API;
Formatos de Data
As Entradas e Saídas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DDThh:mm
Parâmetros de Entrada:
Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Valor Default | Descrição |
page | 1 | Sim | Integer | query | 1 | Página que está sendo requisitada. |
pageSize | 1 | Não | Integer | query | 1002000 | Quantidade de funcionários por registros(Coparticioações) retornados por página. |
product | PROTHEUS | Sim | String | query | Parâmetro de Entrada para registro de origem, atualmente não interfere no retorno das informações. | |
datemodified | 2001-01-01T18:25:43 | Não | String | query | Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA)retorno das coparticipações. | |
branchId | D MG 01 | Sim | String | query | Filial que será utilizada como filtro para retorno das coparticipações. | |
companyId | T1 | Sim | String | query | Empresa que será utilizada como filtro para retorno das coparticipações. | |
authorization | não será informado pelos parâmetros REST | Sim | String | header | Configuração do parâmetro Security = com valor 1 no arquivo appserver.iniini para utilização de segurança básica. |
Parâmetros e Chamada do Método:
Parâmetros e Chamada do Método:
Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:
{protocolo}://{host}/{api}//rh/v1/employeedatacontentBeneficiariesCoparticipation/
Response da API:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "items": [ { "telephone": " { "EmployeeCode": "000006", ", "areaCodeMobileDependentCode": " 00", "workCardSerieSpecialtyName": "9999981", "companyKey": "T1|D MG 01 ", "workShiftSequence": " ", "badgeNumber""ServiceProviderName": " S016 I", ", "streetNumberServiceProviderId": "46942851000154", ", "complementCoparticipationValue": "99.00", "EmployeeName": "FUNCIONARIO TESTE API COPART. ", "DependentName": "FUNCIONARIO TESTE API COPART. ", "branch": " "branch": "D MG 01 ", "salaryCategory "DegreeEmployeeDependency": "M", "roleDescriptionOccurrencyDate": "FUNCAO PADRAO 2015-11-17T00:00:00", ", "workCardNumberCoparticipationDescription": "999999 ", "departamentInternalId": " "ServiceProviderContractType": "1", | "InternationalCodeDiseases": "Z88.1", "socialIntegProgCode "AmountUse": "1", "YearMonthReference": "201901", "codeServiceType": "0000013", "neighborhoodServiceProviderContract": "", "ServiceProvider": "001", "birthDateid": "1963-06-10T00T1|D MG 01 |000006|2015-11-17T00:00:00", |1|001|1| |410|201901" "costCenterInternalId": "000000001" }, "zipCode": " { ", "areaCodeEmployeeCode": " 000006", "name": "JOAO DA SILVA ", "hiringDate": "1999-03-10T00:00:00", "workShiftCode": "001", "city": " ", "roleCode": "00001", "costCenterDescription": "TEC PADRAO ", "gender": "M", "street": "TESTE ", "homeState": "SP", "workCardStateIssuing": "SP", "workShiftInternalId": "D MG |001", "roleInternalId": "D MG |00001", "departamentCode": " ", "demissionDate": "", "costCenterCode": "000000001", "employeePositionDescription": " ", "mobileNumber": " ", "fullName": ""DependentCode": "01", "SpecialtyName": "19", "companyKey": "T1|D MG 01 ", "ServiceProviderName": "S016 I", "ServiceProviderId": "46942851000154", "CoparticipationValue": "9999.00", "employeeSituation": " ", "workshiftDescriptionEmployeeName": "TURNOFUNCIONARIO UNICOTESTE API COPART. ", "DependentName": "DEPENDENTE 001", "branch": "D MG 01 ", ", "idDegreeEmployeeDependency": "T1|D MG 01 |000001", F", "employeePositionCodeOccurrencyDate": "2015-11-17T00:00:00", ", "employeePositionCodeInternalIdCoparticipationDescription": "", | "ServiceProviderContractType": "1", "naturalCity": "SP", "contractEndInternationalCodeDiseases": "Z88.1", "email": " "AmountUse": "1", "YearMonthReference": "201901", "ServiceType": "10", "ServiceProviderContract": "", "departmentDescription": " "ServiceProvider": "001", "id": "T1|D MG 01 |000006|2015-11-17T00:00:00|1|001|2|01|504|201901" "} }], "hasNext": true, "total": 33074 } |
Dados utilizados da API
Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS PROTHEUS | PROPRIEDADES API REST | DESCRIÇÃO |
---|---|---|
SM0->M0_CODIGO + "|" + Se for período aberto usa o campo RHO->RHO_FILIAL e se for perído fechado usa o campo RHP->RHP_FILIAL. | companyKey | Agrupamento de Empresa, Unidade de negócio e Filial. |
Se for período aberto usa o campo RHO->RHO_FILIAL e se for perído fechado usa o campo RHP->RHP_FILIAL. | branch | Filial referente a coparticipação lançada. |
Chave única que identifica os registros dos lançamentos de coparticipações. Se for período aberto usa o índice 4(RHOT10_UNQ) da tabela RHO e se for período fechado usa o índice 3(RHPT10_UNQ) da tabela RHP. | id | Chave única da Coparticipação |
Se perído aberto usa o campo RHO_MAT e se fechado usa o campo RHP_MAT | EmployeeCode | Matrícula do Beneficiário. |
Utiliza o campo RA_NOME da tabela SRA. | EmployeeName | Nome do Funcionário. |
Se for titular usa o campo RHO_CODIGO, se for Dependente usa o campo RHP_CODIGO. Em ambos os casos, caso o valor seja vazio então será retornado "00". | DependentCode | Matrícula do Dependente. |
Se for Titular usa o campo RA_NOME da tabela SRA e se for Dependente usa o campo RB_NOME da tabela SRB. | DependentName | Nome do Beneficiário. |
Se for Titular retorna vazio e se for Dependente usa o campo RB_GRAUPAR da tabela SRB. | DegreeEmployeeDependency | Grau de dependência do Funcionário |
Se for Titular usa o campo RHO_DTOCOR e se for Dependente usa o campo RHP_DTOCOR. | OccurrencyDate | Data de ocorrência do lançamento da coparticipação para o beneficiário. |
Se for Titular usa o campo RHO_CODFOR e se for Dependente usa o campo RHP_CODFOR. | ServiceProvider | Identificador do Prestador de Serviço. |
Se for Titular usa o campo RHO_TPFORN e se for Dependente usa o campo RHP_TPFORN. | ServiceProviderContractType | Tipo de Contrato do Prestador de Serviço indicado no lançamento da Coparticipação do Beneficiário: 1 - Assistência Médica | 2 - Assistência Odontológica | 3 - VR | 4 - VA | 5 - VT | 9 - Outros |
Se for Titular usa o campo RHO_VLRFUN e se for Dependente usa o campo RHP_VLRFUN. | CoparticipationValue | Valor referente ao lançamento da coparticipação do beneficiário. |
Se for Titular usa o campo RHO_COMPPG e se for Dependente usa o campo RHP_COMPPG. | YearMonthReference | Ano e mês de referência do lançamento da coparticipação do beneficiário. |
Se for Titular usa o campo RHO_CID e se for Dependente usa o campo RHP_CID. | SpecialtyName | Nome da especialidade do Prestador de Serviço referente ao lançamento da coparticipação do beneficiário. |
Se for Titular usa o campo RHO_DESPE e se for Dependente usa o campo RHP_DESPE. | InternationalCodeDiseases | Código internacional de Doenças lançado da coparticipação do beneficiário |
Se for Titular usa o campo RHO_TPATEN e se for Dependente usa o campo RHP_TPATEN. . | ServiceType | Tipo de Atendimento informado pelo Prestador de Serviço no lançamento da Coparticipação do Beneficiário: 1 - Eletivo | 2 - PS | 3 - Exame | 4 - PAC | 5 - Material/Medicamento | 6 - Internação | 7 - Terapia | 8 - Taxa/Diária| 9 - Case | 10 - Reembolso | 11 - Remoção | 12 - Não Informado | 13 - Ambulatório |
Vazio em ambos os casos. | CoparticipationDescription | Descrição da Coparticipação referente ao lançamento no histórico do beneficiário. |
"1" em ambos os casos. | AmountUse | Quantidade de utilização de coparticipação por parte do beneficiário e seus dependentes. |
Número do contrato retornado da tabela S074 de acordo com o código do fornecedor e Tipo de Fornecedor (RHO_CODFOR e RHO_TPFORN para titular ou RHP_CODFOR e RHP_TPFORNpara dependente). | ServiceProviderContract | Número do Contrato do Prestador de Serviço indicado no lançamento da Coparticipação do Beneficiário |
CNPJ do Prestador de Serviço retornado da tabela S016 de acordo com o código do fornecedor cadastrado (RHO_CODFOR para titular ou RHP_CODFOR para dependente). | ServiceProviderId | CNPJ do Prestador de Serviço referente ao lançamento da coparticipação do beneficiário |
Nome do Prestador de Serviço retornado da tabela S016 de acordo com o código do fornecedor cadastrado (RHO_CODFOR para titular ou RHP_CODFOR para dependente). | ServiceProviderName | Nome do Prestador de Serviço referente ao lançamento da coparticipação do beneficiário |
Situações de Erros Tratados
O envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução.
Tratamento de erros de integração Protheus:
Mensagens de Pré-Validação
Erro | Mensagem | Solução | API RESPONSE | |||||||||
400 | Campo RA_USERLGA não foi encontrado. | Habilitar o campo RA_USERLGA pelo configurador. |
| |||||||||
400 | O Produto é um parâmetro obrigatório. | Preencher o parâmetro Produto. |
| |||||||||
400 | A Filial é um parâmetro obrigatório. | Preencher o parâmetro Filial. |
|
Mensagens de Pós-Validação
Erro | Mensagem | Solução | API RESPONSE | |||||||||
400 | Nenhum registro localizado. | Informar outra data de alteração para ser utilizada na consulta. |
|
Tratamento de Erros Inesperados(TRY/CATCH):
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "code": 500, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "Ocorreu uma falha no retorno da informação.\r\nErro ao preparar o ambiente com a Empresa e Filial informados!\r\nSaída no final: Falha de conexão com o banco de dados\r\nContacte o administrador do sistema" } |
Checklist de suporte da aplicação
Itens a serem verificados durante o atendimento:
- Verificar se os pré-requisitos foram atendidos para a chamada da API;
- Verificar se na chamada da API o EndPoint, o nome do serviço e todos os campos obrigatórios foram informados;
- Verificar se o retorno da API apresenta algum erro tratado (códigos e mensagens de erro citados neste documento) e consultar a solução na mesma tabela que descreve o erro;
- Em caso de Erro não tratado, verificar se possui alguma informação de banco de dados, conexão com o servidor ou algo que possa identificar a origem do problema.