INTEGRAÇÃO EsocialBranches - Consulta de Cadastro de Filiais

Contexto de negócio (Introdução)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam ainda mais ágeis e intuitivas. Neste contexto, surgiu a necessidade da criação de uma interface que possibilite automatizar o envio dos dados das empresas para o governo,de forma rápida, clara e sem que o cliente necessite adquirir outro módulo do sistema. Desta forma, o desenvolvimento de um Monitor de Eventos foi necessário e todas as informações que trafegam entre ele e o governo são realizadas através de uma interface de integração.

Sistemas Envolvidos

• Protheus - SIGAGPE (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.
• Protheus - SIGATAF (TOTVS Automação Fiscal): Módulo responsável pela gestão dos dados fiscais das empresas e que são enviados ao governo.

Integração

O objetivo desta integração é permitir que o TAF, através do Monitor THF, consiga listar as filiais cadastradas pelo usuário no Protheus.

• Arquitetura (Tecnologia)
  • A integração no Protheus é feita por intermédio de comunicação direta com os Web Services REST (Representation State Transfer) utilizando o formato JSON (JavaScript Object Notation) de serialização de dados, e que através da ativação do serviço do REST do Protheus esteja disponível para utilizar o serviço.

• Premissas e Propriedades
  • O requerente da API será responsável pela requisição e transformação da informação recebida;
  • 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 filiais;

Fora do escopo

• Automatização de Cadastramento de filiais.
• O serviço de disponibilização de dados de Filiais 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;
• Binário Lobo Guará.

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 Grupo de Empresas, Empresas, Unidades de Negócio e Filiais devidamente cadastrados.

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 áreas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das áreas e alinhamento com as diretivas definidas pelo contrato de Integração.

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 Filiais.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de cadastro de Filiais.

Processos

O TAF, através do Monitor THF, realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de filiais e retornar um conjunto de informações pertinentes ao Cadastro de Filiais(SM0) 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.

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 desejados.

• Preenchimento do EndPoint da API GPEA010API;
• Utilizar a chamada do método Get e do Serviço employeedatacontent;
• 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âmetros e Chamada do Método:

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 com o serviço API Rest, a  requisição deverá ser semelhante a imagem abaixo:

Estrutura: { protocolo } : // { endereço servidor Rest } : { Porta Rest } / rest / api / rh / { versão } / EsocialBranches /

Exemplo: http://localhost:8060/rest/api/rh/esocial/v1/EsocialBranches/

Response da API:

{
  		 "items": [
        	{
            	"branchCode": "L MG 01",
            	"branchDescription": "UNIDADE BELO HORIZONTE"
	        },
	        {
    	        "branchCode": "L MG 02",
	            "branchDescription": "UNIDADE UBERABA"
    	    },
        	{
            	"branchCode": "R SP 01",
	            "branchDescription": "UNIDADE SÃO PAULO"
	        },
    	    {
        	    "branchCode": "R SP 02",
            	"branchDescription": "UNIDADE CAMPINAS"
	        }
	    ],
	    "hasNext": false
}

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.

Nos 2 retornos as informações são obtidas da tabela SM0.

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

{
    "errorCode": 400,
    "errorMessage": "Grupo, Empresa e Filial logada não foram informados no parâmetro 'companyId'."
}

{
  "errorCode": 400,
    "errorMessage": "Falha na preparação do ambiente para a Empresa 'T2' e Filial 'D MG 01'."
}

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