INTEGRAÇÃO GPEA923API

Contexto de negócio (Introdução)

Cada vez mais o mercado exige que operações complexas e manipulação de dados sejam mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos, com muitas variáveis a serem analisadas na contratação, os recrutadores precisam de agilidade na análise e uma avaliação mais crítica no momento de contratar um novo recurso.

Com essa necessidade e a importância desta área dentro da empresa, softwares especializados em gestão de pessoal estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface que possibilite automatizar o cadastro do período de estabilidade dos funcionários dentro do ERP 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.
NG

Integração

O objetivo desta integração é permitir que o RH ou área responsável pelo Gestão de Pessoal do Protheus, receba os dados do Controle de Estabilidade dos funcionários de outros sistemas especializados, reduzindo assim o trabalho de inclusão/alteração/exclusão manual dessas informações dentro do sistema;

Benefícios
- Não terá um investimento alto de tempo para o cadastramento, pois os dados já serão enviados, editados ou excluídos através da integração a cada requisição do sistema especialista através da API de Estabilidade.

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.

Escopo

Por intermédio desta integração será disponibilizada a seguinte funcionalidade:

Cadastramento do Período de Estabilidade do funcionário no módulo SIGAGPE;

Fora do escopo

Automatização de consultas de Período de Estabilidade,
Importação de base cadastral - dados do Funcionário,
Informações do Período de Estabilidade que não se enquadram dentro da tabela de Período de Estabilidade

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

Versões mínimas do Protheus: 12.1.30
Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação Protheus.
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.

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 este tópico são:

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 de Recrutamento e Seleção com suas entidades base, devidamente populadas por dados que no momento da integração serão utilizados na criação do registro de currículo.(Para melhor compreensão, analise o cadastro de currículo e verifique os campos que possuem consultas em outras tabelas se as mesmas estão com os seus dados 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 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 à área de Gestão de Pessoal, no processo de cadastramento (inclusão/alteração/exclusão) de Período de Estabilidade.

Cadastro

Esta integração contempla apenas o cadastramento(inclusão/alteração/exclusão) do Período de Estabilidade dentro do módulo SIGAGPE

Processos

O Sistema requisitante enviará as informações via json para a interface de integração, desta forma será gerado um novo registro na tabela de Período de Estabilidade no Protheus, caso tenha êxito na geração do registro, será retornado a mesma estrutura de json confirmando sua gravação, caso contrário enviará as informações de inconsistências citadas nos próximos tópicos.

Limitações / Restrições Gerais

Com o objetivo de manter a estrutura e a agilidade da estrutura Rest, o Web Service Rest receberá registro individual de cada currículo de Período de Estabilidade.
A integração não contemplará exclusão de registros no Protheus, para isso o usuário deverá acessar o ERP e excluir manualmente o mesmo.

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 GPEA923API;
Utilizar a chamada do método Post, Put e Delete e do Serviço StabilityControl;
Preenchimento dos parâmetros obrigatórios da API.

Totvs custom tabs box

tabs	POST,PUT,DELETE
ids	POST,PUT,DELETE

Totvs custom tabs box items

default	no
referencia	POST

Parâmetros de Entrada POST:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição

authorization

usuario:senha

Sim

header

autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.

content

request da api

Sim

body

Estrutura json com informações de cadastro do currículo:

Propriedades Obrigatórias:

Dados de preparação de ambiente:

companyId: Grupo de empresa
branchId: Empresa+Unidade de negócio+Filial

Dados de Período de Estabilidade:

employeeId: Informação pertinente ao funcionário.
startDate: Data do Início do Período de Estabilidade.
stabilityCode: Tipo de Estabilidade registrado.

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

{protocolo}://{host}/{api}/rh/v1/stabilityControl

Request da API:

Bloco de código

language	bash
theme	Eclipse
title	Exemplo de Request da API
linenumbers	true

{
 "companyId": "T1",
 "branchId": "D MG 01 ",
 "employeeId": "T1|D MG 01 |000001",
 "startDate": "2020-01-01T18:25:43",
 "stabilityCode": "T1|D MG    |S01"
}

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.

Propriedade API REST	CAMPO PROTHEUS	DESCRIÇÃO	Formato
companyId		Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchId	RFX_FILIAL	Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial	"D MG 01 "
employeeId	RFX_MAT	Matrícula do Funcionário	"T1\|D MG 01 \|000001"
startDate	RFX_DATAI	Data de Início do Período	"2020-01-01T18:25:43"
stabilityCode	RFX_TPESTB	Tipo de Estabilidade	"T1\|D MG \|S01"

Situações Tratadas

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.

Mensagens Validação

Erro

Mensagem

Solução

API RESPONSE

201

Registro criado.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "companyId": "T1",
    "branchId": "D MG 01 ",
    "startDate": "2020-01-01T18:25:43",
    "employeeId": "T1|D MG 01 |000001",
    "stabilityCode": "T1|D MG    |S01",
    "id": "T1|D MG 01 |T1|D MG 01 |000001|2020-01-01T18:25:43|T1|D MG    |S01"
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedades json companyId ou branchId estão preenchidas com conteúdo válido.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "De-Para de Empresa/Filial não encontrado na base.\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

400

Erro na validação do recebimento da mensagem.

Verificar se a propriedade json employeeId possui informações válidas.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (employeeId) pois não foi possível encontrar esta informação no Protheus'\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

400

Erro na validação do recebimento da mensagem.

Verificar se a propriedade json startDate está no formato correto.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (startDate) pois a data não está no formato correto: 'YYYY-MM-DDTHH:MM:SS'\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

400

Erro na validação do recebimento da mensagem.

Verificar se a propriedade json stabilityCode está com conteúdo existente na tabela S053 - Tipos de Estabilidade do Protheus.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (stabilityCode) pois não foi possível encontrar esta informação no Protheus.\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedades json obrigatórias (companyID , branchId , employeeId, startDate, stabilityCode) estão preenchidas.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Verifique o conteúdo da TAG (employeeId) pois ela é obrigatória para a manipulação deste processo.\r\n\r\n",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

500

Ocorreu uma falha no retorno da informação.

É necessário avaliar se o servidor está funcionando corretamente.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.

Totvs custom tabs box items

default	no
referencia	PUT

Parâmetros de Entrada PUT:

Parâmetro	Valor de Exemplo	Obrigatório	Tipo	Valor Default	Descrição
authorization	usuario:senha	Sim	header	""	autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
stabilityId	T1\|D MG 01 \|T1\|D MG 01 \|000001\|2020-01-01T18:25:43\|T1\|D MG \|S01	Sim	request	""	Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA\|FILIAL\|CHAVE FUNCIONÁRIO\|DATA DE INÍCIO\| CHAVE TIPO DE ESTABILIDADE".
content	layout json	sim	body	""	Estrutura json com informações de cadastro do currículo: *Dados de Período de Estabilidade:* endDate: Data do Final do Período de Estabilidade. stabilityCode: Tipo de Estabilidade

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

{protocolo}://{host}/{api}/rh/v1/stabilityControl

Request da API:

Bloco de código

language	bash
theme	Eclipse
title	Exemplo de Request da API
linenumbers	true

{
    "code": "200",
    "endDate": "2020-01-15T18:30:43",
    "stabilityCode": "T1|D MG    |S02",
    "description": "Operação realizada com sucesso!"
}

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.

Propriedade API REST	CAMPO PROTHEUS	DESCRIÇÃO	Formato
companyId		Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchId	RFX_FILIAL	Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial	"D MG 01"
employeeId	RFX_MAT	Matrícula do Funcionário.	"T1\|D MG 01 \|000001"
startDate	RFX_DATAI	Data de Início do Período	"2020-01-01T18:25:43"
stabilityCode	RFX_TPESTB	Descrição do resumo de qualificações	"T1\|D MG \|S01"

Situações Tratadas

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.

Mensagens Validação

Erro

Mensagem

Solução

API RESPONSE

200

Operação realizada com sucesso.

Registro foi alterado com sucesso.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": "200",
    "description": "Operação realizada com sucesso!"
}

400

Erro na validação do recebimento da mensagem.

Verificar se as tags companyID , branchId , employeeI possuem conteúdo igual ao parâmetro stabilityId.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Informação do pacote difere do parâmetro stabilityId, favor verificar e reenviar.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado.

Dados de Empresa e Filial,
Dados de Filial e Matrícula,
Formato da Data de Início,
Tipo de Estabilidade.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Informação stabilityId ausente ou inválida.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

500

Ocorreu uma falha no retorno da informação.

É necessário avaliar se o servidor está funcionando corretamente.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.

Totvs custom tabs box items

default	no
referencia	DELETE

Parâmetros de Entrada DELETE:

Parâmetro	Valor de Exemplo	Obrigatório	Tipo	Valor Default	Descrição
authorization	usuario:senha	Sim	header	""	autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
stabilityId	T1\|D MG 01 \|T1\|D MG 01 \|000001\|2020-01-01T18:25:43\|S01	Sim	query	""	Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA\|FILIAL\|CHAVE FUNCIONÁRIO\|DATA DE INÍCIO\| CHAVE TIPO DE ESTABILIDADE".

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

{protocolo}://{host}/{api}/rh/v1/stabilityControl

Situações Tratadas

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.

Mensagens Validação

Erro

Mensagem

Solução

API RESPONSE

200

Operação realizada com sucesso.

Registro foi deletado com sucesso.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": "200",
    "description": "Operação realizada com sucesso!"
}

400

Erro na validação do recebimento da mensagem.

Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado.

Dados de Empresa e Filial,
Dados de Filial e Matrícula,
Formato da Data de Início,
Tipo de Estabilidade.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 400,
    "detailedMessage": "Informação stabilityId ausente ou inválida.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": "Erro na validação do recebimento da mensagem."
}

500

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamente.

Bloco de código

theme	Eclipse
linenumbers	true
collapse	true

{
    "code": 500,
    "detailedMessage": "Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "message": Descrição do erro.
}

OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.

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.

Páginas filhas

Versões comparadas

Versão antiga 12

Nova versão 13

Chave

INTEGRAÇÃO GPEA923API

Contexto de negócio (Introdução)

Sistemas Envolvidos

Integração

Escopo

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

Instalação/Atualização

Ativação/Desativação da integração

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Limitações / Restrições Gerais

Como realizar a chamada da API REST

Parâmetros de Entrada POST:

Situações Tratadas

Parâmetros de Entrada PUT:

Situações Tratadas

Parâmetros de Entrada DELETE:

Situações Tratadas

Checklist de suporte da aplicação

Anexos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 12

Nova versão 13

Chave

INTEGRAÇÃO GPEA923API

Contexto de negócio (Introdução)

Sistemas Envolvidos

Integração

Escopo

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

Instalação/Atualização

Ativação/Desativação da integração

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Limitações / Restrições Gerais

Como realizar a chamada da API REST

Parâmetros de Entrada POST:

Situações Tratadas

Parâmetros de Entrada PUT:

Situações Tratadas

Parâmetros de Entrada DELETE:

Situações Tratadas

Checklist de suporte da aplicação

Anexos