Integrações

Páginas filhas
  • Controle de Abonos - AllowanceControl

Versões comparadas

Versão antiga 2

changes.mady.by.user Wesley Alves Pereira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Suelen de Lima Silva

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Controle de Abonos - AllowanceControl - INTEGRAÇÃO PONA350API 

Sistemas Envolvidos

  • Protheus (módulo de Ponto Eletrônico): Módulo responsável pela gestão da assiduidade e marcações/apontamentos de horários de trabalho do funcionário, dentre outros cadastros pertinentes aos colaboradores.

  • Quírons - 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 Abono de marcações de ponto 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 Abono.
    • A informação será atualizada de forma automática, facilitando que conferência e confiabilidade dos dados recebidos.
  • 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:

  • Manutenção de Lançamentos de Pré-Abono do funcionário no módulo SIGAPON;

Fora do escopo

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

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

  • Versões mínimas do Protheus: 12.1.23
  • 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:

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

  • Protheus com sua arquitetura devidamente estruturada.
  • Módulo de Ponto Eletrônico (SIGAPON) com suas entidades base, devidamente populadas por dados que no momento da integração serão utilizados na criação do registro de abono. (Para melhor compreensão, analise o cadastro disponível dentro do sistema 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 Protheus, onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente à área de Ponto Eletrônico,

INTEGRAÇÃO PONA350API

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 dos abonos do 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 Abonos 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 Abonos.
  • 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 Abono do funcionário no módulo SIGAGPE;

Fora do escopo

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

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:

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 Abonode abonos de marcações de horário de ponto.

Cadastro

Esta integração contempla apenas o cadastramento(inclusão/alteração/exclusão) do Abono do Abono dentro do módulo SIGAGPE SIGAPON.

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 Abono serão atualizados os dados de abono de marcações dentro do cadastro de pré abono no Protheus, caso tenha êxito na geração do registro, será retornado retornada a mesma estrutura de json confirmando json recebida, acompanhada de uma nova tag chamada id, que será uma chave única composta de informações da entidade dentro do sistema.  Desta forma será confirmada sua gravação, caso contrário enviará as informações de inconsistências que serão 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á o registro individual de cada registro de Abono.
  • 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.
  • de Abono.

Como realizar a chamada

Como realizar a chamada

da API REST

Para realizar a integração com o parceiro TOTVS é necessário são necessárias as informações básicas de consulta para retorno dos funcionários desejadosdo funcionário desejado.

  • Preenchimento do EndPoint da API PONA350API;
  • Utilizar a chamada do método Post, Put e Delete e do Serviço StabilityControl AllowanceControl;
  • Preenchimento dos parâmetros obrigatórios da API.




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

Totvs custom tabs box
tabsPOST,PUT,DELETE
idsPOST,PUT,DELETE

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/v2/StabilityControl

Image Removed

Request da API:

{ "companyId": "T1", "branchId": "D MG 01 ", "employeeId": "000001", "startDate": "20200101", "stabilityCode": "S01" }
Totvs custom tabs box items
defaultno
referenciaPOST

Parâmetros de Entrada POST:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header


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

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 Abono:

  • employeeId: Informação pertinente ao funcionário.
  • startDate: Data do Início do abono.
  • endDate: Data do Final do abono.
  • startTime: Hora do Início do abono.
  • endTime: Hora do Final do abono.
  • code: Tipo de Abono registrado.
Bloco de código
languagebash
themeEclipse
titleExemplo de Request da API
linenumberstrue
{
"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10"
}		simbody

Estrutura json com informações do abono de marcações do funcionário:

Dados de preparação de ambiente:

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

Dados de Abono:

  • employeeId: Informação pertinente ao funcionário.
  • startDate: Data do Início do abono.
  • endDate: Data do Final do abono.
  • startTime: Hora do Início do abono.
  • endTime: Hora do Final do abono.
  • code: Tipo de Abono 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/allowanceControl

Image Added


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 todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes.

Propriedade API RESTCAMPO PROTHEUSDESCRIÇÃOFormato
companyId
Informações de acesso ao sistema, campo contém informação do grupo de empresa"T1"
branchId
RFX
RF0_FILIALInformações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial"D MG 01 "
employeeId
RFX
RF0_MAT
Matrícula
chave do Funcionário"T1|D MG 01 |000001""
startDate
RFX
RF0_
DATAI
DTPREIData
de Início
inicial do
Período
abono"
20200101
2020-01-01T18:25:43"
code
endDate
RFX
RF0_
TPESTB
Tipo de Abono"S01"
DTPREFData final do abono"2020-01-01T18:25:43"
startTimeRF0_HORINIhora inicial do abono"10:00"
endTimeRF0_HORFIMhora final do abono"15:00"
code

P6_CODIGO

chave do tipo de abono"T1| D MG   | 107"

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
201Created.Registro incluído com sucesso

Erro

Mensagem

Solução

API RESPONSE201Created.Registro incluído com sucesso.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
    "code": "200",
    "description": "CREATED."
}

400

Erro no momento da listagem do registro.

Verificar se as propriedade json id está preenchida e com dados válidos no pacote enviado
.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{ "errorCode
"companyId":"T1",
"branchId":
400, 
"D MG 01 ",
"
errorMessage
employeeId":
"
ERRO
T1|D
NO
MG
MOMENTO DA LISTAGEM DO REGISTRO." }500

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamente.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 500,
   "errorMessage": "ERRO NO ACESSO AO ENDPOINT"
}

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.

01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"

400

Erro no momento da listagem do registro.

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

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
    "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."
}
500

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamente.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
    "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.


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/v2/StabilityControl

Image Removed

Request da API:

Totvs custom tabs box items
defaultno
referenciaPUT

Parâmetros de Entrada PUT:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header


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

T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107

Simrequest

Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATADEINÍCIO;HORADEINICIO;CHAVE TIPODEABONO".

contentlayout jsonsimbody

Estrutura json com informações do abono de marcação de ponto:

Dados de preparação de ambiente:

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

Dados de solicitação de abono:

  • employeeId: Informação pertinente ao funcionário.
  • startDate: Data inicial do abono.
  • endDate: Data final do abono.
  • startTime: Horário do Início do abono.
  • endTime: Horário do final do abono.
  • code: Tipo de abono 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/allowanceControl{allowanceId}

Image Added


Dados utilizados da API

Por ser uma estrutura única para todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes.

Propriedade API RESTCAMPO PROTHEUSDESCRIÇÃOFormato
companyId
Informações de acesso ao sistema, campo contém informação do grupo de empresa"T1"
branchId
Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial" D MG 01 "
employeeIdRF0_MATchave do Funcionário."T1|D MG 01 |000001"
startDateRF0_DTPREIData de Início do abono"2020-01-01T18:25:43"
endDateRF0_DTPREFData do Final do abono"2020-01-01T18:25:43"
startTimeRF0_HORINIHora inicial do abono"10:00"
endTimeRF0_HORFIMHora final do abono"15:00"
codeP6_CODIGOchave do tipo de abono"T1|D MG   |107"

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
200Atualizado com sucesso.Registro alterado com sucesso.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"

400

Erro no momento da listagem do registro.

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

Totvs custom tabs box items
defaultno
referenciaPUT

Parâmetros de Entrada PUT:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header

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

'T1|D MG 01 |000001|20200101|S01'

Simrequest""

Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|RFX_FILIAL|RFX_MAT|RFX_DATAI|RFX_TPESTB".

contentlayout jsonsimbody""

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

Dados do abono:

  • endDate: Data do Final do Abono.
Bloco de código
languagebash
themeEclipse
titleExemplo de Request da API
linenumberstrue
{
 "endDate": "20200115"
}

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 RESTCAMPO PROTHEUSDESCRIÇÃOFormatocompanyIdInformações de acesso ao sistema, campo contém informação do grupo de empresabranchIdInformações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ FilialemployeeIdRFX_MATMatrícula do Funcionário."000001"startDateRFX_DATAIData de Início do Período"20200101"endDateRFX_DATAFData do Final do Período"20200115"stabilityCodeRFX_TPESTBDescrição do resumo de qualificações"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 RESPONSE200Atualizado com sucesso.Registro alterado com sucesso

.

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
    
    "code":
 "200"
 400,
    "description
    "detailedMessage":
 
 "
ATUALIZADO
Informação allowanceId
COM SUCESSO." }

400

Erro no momento da listagem do registro.

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

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{ 
ausente ou inválida.",
    "
errorCode
helpUrl":
400
"https://tdn.totvs.com/x/ZYNvI",
    "
errorMessage
message": "
ERRO
Erro
NO
na
MOMENTO
validação
DA
do
LISTAGEM
recebimento
DO
da
REGISTRO
mensagem."
}
500

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamente.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
    "code": 500,
    "detailedMessage":
"errorCode": 500
"Ocorreu uma falha no retorno da informação.",
    "helpUrl": "https://tdn.totvs.com/x/ZYNvI",
    "
errorMessage
message":
"ERRO
Descrição
NO ACESSO AO ENDPOINT"
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.



'T1|D MG 01 |000001|20200101|S01'
Totvs custom tabs box items
defaultno
referenciaDELETE

Parâmetros de Entrada DELETE:

Parâmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header

""


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

"T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"

Simquery
""

Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA

|RFX_FILIAL|RFX_MAT|RFX_DATAI|RFX_TPESTB

;FILIAL;CHAVEFUNCIONARIO;DATADEINÍCIO;HORADEINICIO;CHAVE TIPODEABONO".

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/v2/StabilityControlv1/allowanceControl{allowanceId}

Image AddedImage Removed

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
204
200Atualizado com sucesso.Registro foi deletado com sucesso.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
    
    "code":
 
 "
204
200",
    
    "description":
 
 "
ATUALIZADO
Opera��o realizada
COM
com
SUCESSO.
sucesso!"
}

400

Erro no momento da listagem do registro.

Verificar se a propriedade json

id

allowanceId está preenchida e com dados válidos no pacote enviado .

Bloco de código
themeEclipse
linenumberstrue
collapsetrue{
collapsetrue
{
    "code": 400,
    "detailedMessage": "Informação allowanceId ausente ou inválida.",
    "
errorCode
helpUrl":
400
"https://tdn.totvs.com/x/ZYNvI",
    "
errorMessage
message": "
ERRO
Erro
NO
na
MOMENTO
validação
DA
do
LISTAGEM
recebimento
DO
da
REGISTRO
mensagem."
}
500

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamente.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{ 
{
    "code": 500,
    "
errorCode
detailedMessage":
500
 "Ocorreu uma falha no retorno da informação.",
    "
errorMessage
helpUrl": "
ERRO NO ACESSO AO ENDPOINT."
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.


Anexos