INTEGRAÇÃO GPEA001API - Serviço genérico para retorno das informações de Plano de Saúde do Microsiga Protheus

Contexto de negócio (Introdução)

Documentação técnica para auxiliar o desenvolvimento de APIs de integração com os produtos TOTVS.

Sistemas Envolvidos

Integração passiva que poderá ser consumida pelas linhas RM, DataSul e Protheus.

Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam 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 que torne possível automatizar 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, 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 área responsável pelos cadastros, enviem seus dados para o sistema da DIVICOM e assim reduz 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, inclui as informações dos beneficiários manualmente, com a interface de integração isso será feito de forma automática.
  • Não terá um investimento alto de tempo para o cadastramento, pois os dados 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

Integração

O que levou a criação da integração / o porquê da integração (Finalidade/Objetivo), de forma macro, o que será integrado do, por exemplo, Vertical com o ERP (BackOffice)

Explique o contexto de negócio ou do problema na qual esta integração estará inserida. Isto inclui o funcionamento da(s) ponta(s) envolvida(s).

Apresentar a integração como uma melhoria para o cenário ou como uma solução para o problema.

• Premissas

• • parceiro que será responsável pela requisição e transformação da informação recebida;

• • Cada produto deve ter habilitado um LOG de

• • alteração(

• • RHK_

• • USERGA e RHL_USERGA) de registros a fim de controlar os dados a serem integrados;

• • Na requisição, o parceiro

• • deve informar a data referente às alterações dos dados que deseja obter, através do preenchimento do parâmetro 

• • datemodified e, se desejar uma carga completa, deve deixar o parâmetro sem preenchimento. Caso seja solicitada a carga, todos os dados

• • do cadastro serão enviados novamente. Caso

• • seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;

• • A data de alteração do registro deverá ser enviada em cada processo, 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 (quantidade de registros) e qual página ela solicita;

• • Cabe a integração informar se existem mais páginas a serem solicitadas

• Arquitetura (Tecnologia)

• • .

Escopo

Descreva, dado o contexto, qual o escopo de atuação da integração. Cite as áreas/perfis de usuários e funções impactadas. Se existe uma parte do contexto de negócio que a integração não tenta resolver, deixe explícito.

Defina exatamente o que a integração FAZ, o que ela NÃO FAZ e a sua finalidade.

[O conteúdo poderá estar disponível na ferramenta PMS – Painel de Gestão de Projetos, opção Plano do Projeto]

Como são os processos os que serão integrados, mas com uma visão geral e não só o ponto de integração caso contrário a homologação [ou outro que pegar o documento] não saberá do que se trata no sistema vertical, de forma sucinta, como funciona e o(s) ponto(s) de integração.

Citar a responsabilidade de cada produto.

Descrever com mais detalhes sobre o que será integrado (mas não ser especialista nas entidades/processos, pois suas particularidades serão descritas posteriormente) incluindo diagramas, prints, imagens, etc o que for interessante para auxiliar o entendimento.

Interessante aqui a inclusão de diagramas, imagens, lógicas, fluxo(s) do(s) processo(s) o que considerar interessante e agregador ao documento e ao escopo.

Por intermédio desta integração estará disponível a seguinte funcionalidade:

• Consulta de Beneficiários de Plano de Saúde;

Pré-requisitos instalação/implantação/utilização

• Versões mínima do Protheusdo Protheus: 12.1.25

• Ferramentas que são necessárias a integração, como: EAI, ESB, servidor de WebService etc.
• Aspectos legais nos quais as partes envolvidas na integração devem estar inseridas, caso as informações envolvidas sejam utilizadas para o cumprimento de alguma lei específica.
• Requisitos de hardware ou Software, como servidores, link de internet, capacidade de armazenamento e memória, sistema operacional.

• ;
• 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 tráfego de dados sem interrupção;
• Protheus devidamente configurado e serviço Rest habilitado em seu server.
• Campos RHK_USERGA e RHL_USERGA devem estar habilitados. 

Fora do escopo

• Automatização de Cadastramento de Beneficiários;
• O serviço de disponibilização de dados de Beneficiários apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante.
• Dependentes que não fazem uso do benefício de Plano de Saúde não serão transmitidos.

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 o cadastro de Dependentes devidamente preenchido.
• Módulo Gestão de Pessoal com o cadastro de Planos de Saúde Ativos devidamente preenchido

Instalação/Atualização

Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:

• Procedimentos que devem ser observados quando um dos produtos for atualizado.
• Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
• Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
• Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
• Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
• Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
• Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.

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

 Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.

Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.

Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.

Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

Notas:

Esta integração traz a funcionalidade exclusivamente de cadastro de Beneficiários de Plano de Saúde.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de cadastro de Beneficiários de Plano de Saúde.

Processos

A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de beneficiários e retornar um conjunto de informações pertinentes ao Cadastro de Dependentes (GPEA020) e Cadastro de Planos de Saúde Ativos (GPEA001) 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

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações / Restrições Gerais

- O serviço de disponibilização de dados de Funcionário apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante;

• produto deverá gerar um LOG de inclusão e alteração 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 updateDate se deseja a carga completa(deixando o parâmetro vazio) ou somente os dados que foram atualizados(Informando a data de alteração). Caso seja solicitada a carga, todos os dados deverão ser enviados novamente. Caso seja solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;

• 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 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 beneficiários desejados.;

• Preenchimento do EndPoint da API GPEA010API GPEA001API;
• Utilizar a chamada do método Get e do Serviço employeedatacontent BeneficiariesDataContent;
• 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:ssZ.

Parâmetros de Entrada:

Parâmetros e Chamada do Método:

Image Removed

Response da API:

Image Removed

Image Removed

A autenticação será do tipo Basic Authorization e será obrigatório (configuração do parâmetro Security = 1 no arquivo appserver.ini).

Página do Serviço REST:

Image Added

Parâmetros e Chamada do Método:

Para a realização de testes, foi utilizado a ferramenta POSTMAN e após a configuração do server Protheus e da API Rest, a  requisição deverá ser semelhante a imagem abaixo:

Estrutura: {protocolo}://{host:porta}/{rest}/{api}/rh/v1/BeneficiariesDataContent/

Exemplo: http://localhost:8034/rest/api/rh/v1/BeneficiariesDataContent/

Retorno da API:

{
    "items": [
        {
            "identityNumber": "",
            "MaritalState": "",
            "BenefitCPF": "10084068809",
            "companyKey": "T1|D MG 01 ",
            "IdentityNumberEmitterAgency": "",
            "ContractNumberCode": "",
            "BenefitVendorSegmentCode": "1",
            "branch": "D MG 01 ",
            "BenefitCode": "01",
            "BeneficiaryTall": "",
            "beginDate": "012015",
            "BenefitVendorInternalId": "",
            "code": "01",
            "FinalDate": "      ",
            "Birth": "2000-01-01T00:00:00",
            "MotherName": "",
            "BornAlive": "1",
            "DentalAssistanceCardCode": "                    ",
            "EmployeeInternalId": "",
            "BenefitsVendorCode": "001",
            "Name": "DEPENDENTE 001                ",
            "SUSCardCode": "1267778459364  ",
            "Gender": "M",
            "DegreeOfRelatedness": "F",
            "EmployeeCode": "000006",
            "RegistryType": "",
            "MedicalAssistanceCard": "96845712333         ",
            "BeneficiaryWeight": "",
            "BenefitInternalId": "",
            "ContractNumberInternalId": "",
            "FoodCardsCode": "",
            "id": "D MG 01 |000006|01|1|001|1|01",
            "MealCardsCode": ""
        }
    ],
    "hasNext": true,
    "total": 10
}

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.

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
404	Campo RA_USERLGA não foi encontrado.	Habilitar o campo RA_USERLGA pelo configurador.	Image Removed
404	O Produto é um parâmetro obrigatório.	Preencher o parâmetro Produto.	Image Removed
404	A Filial é um parâmetro obrigatório.	Preencher o parâmetro Filial.	Image Removed
400	"Os campos RHK_USERGA, RHL_USERGA, RHK_MATSAU, RHK_MATODO, RHK_CNS, RHL_MATSAU, RHL_MATODO e RHL_CNS são obrigatórios e não foram encontrados.	Habilitar pelo configurador os campos citados na mensagem de Erro.	Bloco de código language js theme Confluence title Product { "code": 400, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "Os campos RHK_USERGA, RHL_USERGA, RHK_MATSAU, RHK_MATODO, RHK_CNS, RHL_MATSAU, RHL_MATODO e RHL_CNS são obrigatórios e não foram encontrados." }
400	O parâmetro product é obrigatório.	Preencher o parâmetro product.	Bloco de código language js theme Confluence title Product { "code": 400, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "O parâmetro product é obrigatório." }
400	O parâmetro branchId é obrigatório	Preencher o parâmetro branchId.	Bloco de código language js theme Confluence title branchId { "code": 400, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "O parâmetro branchId é obrigatório." }
400	O parâmetro companyId é obrigatório.	Preencher o Parâmetro companyId.	Bloco de código language js theme Confluence title companyId { "code": 400, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "O parâmetro companyId é obrigatório." }
400	Se preenchido, o parâmetro datemodified deve estar no formato: '2019-05-01T18:25:43'.	Preencher o Parâmetro datemodified no formato padrão.	Bloco de código language js theme Confluence title companyId { "code": 400, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "Se preenchido, o parâmetro datemodified deve estar no formato: '2019-05-01T18:25:43'." }
400	Filial não encontrada para os valores informados de empresa e Filial: XX X XX XX	Preencher uma filial válida.	Bloco de código language js theme Confluence title companyId { "code": 400, "detailedMessage": "", "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ", "message": "Filial não encontrada para os valores informados de empresa e Filial: X1 D MG 01" }	404	A página é um parâmetro obrigatório e deve ser maior que 1.	Preencher o parâmetro Page com um valor maior que 1.	Image Removed

Mensagens de Pós-Validação

{
    "code": 400,
    "detailedMessage": "",
    "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
    "message": "Nenhum registro localizado."
}

Tratamento de Erros Inesperados(TRY/CATCH):Image Removed

{
   "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.

Anexos