Páginas filhas
  • Controle de Estabilidade - stabilityControl

Versões comparadas

Chave

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

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:

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 candidatoPerí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
tabsPOST,PUT,GET,DELETE
idsPOST,PUT,GET,DELETE

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

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 de Entrada PUT:

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

Image Removed

Request da API:

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 para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
contentrequest 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 currículo.Período de Estabilidade:

  • employeeIdcpfInformação pertinente ao candidatofuncionário.
  • namestartDate: Nome do candidato 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 SOAP UI 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/candidatesStabilityControl

Image RemovedImage Added

Request da API:

Bloco de código
languagebash
themeEclipse
titleExemplo de Request da API
linenumberstrue
{
	 "companyId": "T1",
	 "branchId": "D MG 01 ",
    "idemployeeId": "000001",
    "NamestartDate": "JOÃO PEREIRA DA SILVAI20200101",
    "BirthstabilityCode": "01/01/1990S01",
    "HomeState": "MG",
    "Naturalness": "Belo Horizonte",
    "NickName": "Jão",
    "Sex": "M",
    "Nationality": "10",
    "EducationalLevel": "9",
    "Street": "Rua Mata Atlantica",
    "Number": "333",
    "District": "Planalto",
    "State": "MG",
    "City": "Belo Horizonte",
    "Cep": "30100020",
    "Country": "Brasil",
    "ProfessionalRegistrationNumber": "Reg-00098",
    "Cpf": "51427362653",
    "ImageId": 844,
    "PhoneNumber1": "4613636",
    "PhoneNumber2": "4613636",
    "identityNumber": "M 267392",
    "IdentityNumberEmitterState": "MG",
    "IdentityNumberEmitterAgency": "SSP",
    "IdentityNumberEmissionDate": "1993-04-25T00:00:00",
    "ElectoralCard": "123.334",
    "ElectoralWard": "0012",
    "ElectoralSection": "0006",
    "WorkCard": "015116",
    "WorkCardSerialNumber": "00001",
    "WorkCardEmitterState": "MG",
    "WorkCardEmissionDate": "1993-03-01T00:00:00",
    "Nit": 0,
    "DriversLicense": "13.344.543",
    "DriversLicenseType": "A",
    "DriversLicenseExpirationDate": "1997-02-05T00:00:00",
    "MilitaryDischargeCertificate": "12856945678",
    "MilitaryGrade": "CDI",
    "BrazilConsort": 0,
    "Naturalized": 0,
    "BrazilianChildren": 0,
    "BrazilianChildrenNumber": "2",
    "Email": "[email protected]",
    "PreviousTrainingInvestment": "2300.00",
    "ShadeRace": "0",
    "Disabled": 0,
    "UserCode": "simone",
    "PhoneNumber3": "21229000",
    "Company": "RM SISTEMAS S.A",
    "OccupationCode": "10",
    "Rehabilitated": 0,
    "Smoker": 0,
    "AdjustsImageSize": 0,
    "DeafPerson": 0,
    "MutePerson": 0,
    "BlindPerson": 0,
    "MentallyImpairedPerson": 0,
    "CurriculumApprovalDate": "2005-04-01T09:36:02.66",
    "Student": 1,
    "Teacher": 1,
    "Candidate": 1,
    "BibliosUser": 1,
    "Employee": 1,
    "FormerEmployee": 0,
    "IntellectualImpairedPerson": 0,
    "Deceased": 0,
    "Age": 53,
    "RegistryDate": "2019-05-02T20:32:12.931Z",
    "WageExpectation": "1111.32",
    "AreaOfInterestCode1": "15",
    "AreaOfInterestCode2": "15",
    "WageExpectationTradable": "1",
    "azerienceTime": "15",
    "WorkExperienceTimeArea1": "15",
    "WorkExperienceTimeArea2": "15",
    "ContraIndicated": "1",
    "ContraindicationReason": "string",
    "Available": "1",
    "FormOfRecruitment": "string",
    "ResumeSkillsId": "15",
    "HierarchyLevelCode": "15",
    "ProfessionalProfileDescription": "string",
    "AreaOfInterestDescription1": "string",
    "AreaOfInterestDescription2": "string",
    "HierarchyLevelDescription": "string",
    "ProfessionalSkillsResumeDescription": "string",
    "Employee1": "string",
    "PersonalEmail": "string",
    "MaritalState": "string",
    "Complement": "string",
    "ArrivalDate": "2019-05-02T20:32:12.931Z",
    "LetterModel19": "string",
    "Rne": "string",
    "ImmigrationDecree": "string",
    "RneExpirationDate": "2019-05-02T20:32:12.931Z",
    "WorkCardExpirationDate": "2019-05-02T20:32:12.931Z",
    "VisaType": "string",
    "PassportNumber": "string",
    "NativeCountry": "string",
    "PassportExpirationDate": "2019-05-02T20:32:12.931Z",
    "AccessibilityFeaturesForJobLocal": "string",
    "MilitaryDivision": "string",
    "MilitaryCertificateEmissionDate": "2019-05-02T20:32:12.931Z",
    "MilitaryCertificateEmitterAgency": "2019-05-02T20:32:12.931Z",
    "MilitaryRegion": "string",
    "MilitarySituation": "string",
    "ElectoralCardEmitterState": "string",
    "BloodType": "string",
    "Image": "string",
    "NeighborhoodTypeCode": "15",
    "NaturalnessCode": "string",
    "NaturalisationDate": "2019-05-02T20:32:12.931Z",
    "DriversLicenseEmitterAgency": "string",
    "RneEmitterAgency": "string",
    "CountryId": "1",
    "DeceaseDate": "2019-05-02T20:32:12.931Z",
    "DeathCertificateNumber": "string",
    "NaturalisationGatehouse": "string",
    "BrazilConditionClassification": "string",
    "DriversLicenseFirstEmissionDate": "2019-05-02T20:32:12.931Z",
    "FirstJobYear": "15"
}

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ÇÃOFormato
companyIdInformaçõ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+ Filial
NameQG_NOMENome do Candidato"JOÃO PEREIRA  SILVA"
RegistryDateQG_DTCADData do Registro2019-05-02T20:32:12
DistrictQG_BAIRROBairroBARRA FUNDA
CityQG_MUNICIPMunicipSAO PAULO
StateQG_ESTADOEstadoSP
CepQG_CEPCep12345678
PhoneNumber1QG_FONEFonePhoneNumber2QG_FONECELFone CelularPhoneNumber3QG_FONECOMFone Comercial
identityNumberQG_RGRG123456789
CpfQG_CICCPF12345678900
WorkCardQG_NUMCPNum CPWorkCardSerialNumberQG_SERCPSerie CPWorkCardEmitterStateQG_UFCPUF CPDriversLicenseQG_HABILITHabilitaçãoMilitaryDischargeCertificateQG_RESERVReservistaElectoralCardQG_TITULOETitulo EleitorStreet + NumberQG_ENDERECEndereçoElectoralWard+ElectoralSectionQG_ZONASECZona Eleitoral
SexQG_SEXOSexoF - Feminino; M - Masculino.
MaritalStateQG_ESTCIVEstado Civil

C - Casado; D - Divorciado; M - União Estável; 
Q - Desquitado; S - Solteiro; V - Viúvo. 

HomeStateQG_NATURALNaturalidade - UFSP
NationalityQG_NACIONANacionalidade10
BirthQG_DTNASCData de Nascimento1900-01-01T01:01:01
"001" QG_SITUACSituac (Status Disponível)
EmailQG_EMAILEmail[email protected]
DisabledQG_DFISICODeficiente fisico

1- Sim; 2 - Não.

NaturalnessQG_MUNNASCNaturalidadeSAO PAULO
AreaOfInterestCode1QG_AREACódigo da área de interesse 1HierarchyLevelCodeQG_NIVHIERCódigo do nível hierárquicoWorkExperienceTimeQG_TPEXPERTempo de experiência profissional
WageExpectationQG_PRETSALPretensão Salarial1000.00
ArrivalDateQG_ANOCHEGData de chegada no Brasil1900-01-01T01:01:01
ProfessionalSkillsResumeDescriptionQG_MEMO2Descrição do resumo de qualificações

Erro

Mensagem

Solução

API RESPONSE

400

Verificar se a propriedade (name) está preenchida.

Verificar se a propriedade json name está preenchida no pacote enviado .

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "VERIFICAR SE A PROPRIEDADE (Name) ESTÁ PREENCHIDA, POIS A MESMA É OBRIGATÓRIA PARA GERAÇÃO DO CADASTRO DE CURRÍCULO.\r\n"
}
400

Verificar se a propriedade (AreaOfInterestCode1)  possui cadastro no Protheus.

É necessário analisar o cadastro dentro do Protheus, para checagem se o código da área de interesse existe no Protheus, é possível checar pela própria tela de currículo.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "VERIFICAR SE A PROPRIEDADE (AreaOfInterestCode1) POSSUI CADASTRO DO PROTHEUS E REENVIAR.\r\n"
}
400

Verificar se a propriedade (Cpf)  está preenchida.

Verificar se a propriedade json cpf está preenchida no pacote enviado .
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
  "errorMessage": "VERIFICAR SE A PROPRIEDADE (Cpf) ESTÁ PREENCHIDA, POIS A MESMA É OBRIGATÓRIA PARA GERAÇÃO DO CADASTRO DE CURRÍCULO.\r\n"
}
Totvs custom tabs box items
defaultno
referenciaPUT

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.
candidatesId'T1|D MG 01|12345678910'Simrequest""

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

contentlayout jsonsimbody""

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 currículo.

  • cpf: Informação pertinente ao candidato
  • name: Nome do candidato.
Bloco de código
languagebash
themeEclipse
titleExemplo de Request da API
linenumberstrue
{
	"companyId":"T1",
	"branchId":"D MG 01",
    "id": "000001",
    "Name": "JOÃO PEREIRA DA SILVAI",
    "Birth": "01/01/1990",
    "HomeState": "MG",
    "Naturalness": "Belo Horizonte",
    "NickName": "Jão",
    "Sex": "M",
    "Nationality": "10",
    "EducationalLevel": "9",
    "Street": "Rua Mata Atlantica",
    "Number": "333",
    "District": "Planalto",
    "State": "MG",
    "City": "Belo Horizonte",
    "Cep": "30100020",
    "Country": "Brasil",
    "ProfessionalRegistrationNumber": "Reg-00098",
    "Cpf": "51427362653",
    "ImageId": 844,
    "PhoneNumber1": "4613636",
    "PhoneNumber2": "4613636",
    "identityNumber": "M 267392",
    "IdentityNumberEmitterState": "MG",
    "IdentityNumberEmitterAgency": "SSP",
    "IdentityNumberEmissionDate": "1993-04-25T00:00:00",
    "ElectoralCard": "123.334",
    "ElectoralWard": "0012",
    "ElectoralSection": "0006",
    "WorkCard": "015116",
    "WorkCardSerialNumber": "00001",
    "WorkCardEmitterState": "MG",
    "WorkCardEmissionDate": "1993-03-01T00:00:00",
    "Nit": 0,
    "DriversLicense": "13.344.543",
    "DriversLicenseType": "A",
    "DriversLicenseExpirationDate": "1997-02-05T00:00:00",
    "MilitaryDischargeCertificate": "12856945678",
    "MilitaryGrade": "CDI",
    "BrazilConsort": 0,
    "Naturalized": 0,
    "BrazilianChildren": 0,
    "BrazilianChildrenNumber": "2",
    "Email": "[email protected]",
    "PreviousTrainingInvestment": "2300.00",
    "ShadeRace": "0",
    "Disabled": 0,
    "UserCode": "simone",
    "PhoneNumber3": "21229000",
    "Company": "RM SISTEMAS S.A",
    "OccupationCode": "10",
    "Rehabilitated": 0,
    "Smoker": 0,
    "AdjustsImageSize": 0,
    "DeafPerson": 0,
    "MutePerson": 0,
    "BlindPerson": 0,
    "MentallyImpairedPerson": 0,
    "CurriculumApprovalDate": "2005-04-01T09:36:02.66",
    "Student": 1,
    "Teacher": 1,
    "Candidate": 1,
    "BibliosUser": 1,
    "Employee": 1,
    "FormerEmployee": 0,
    "IntellectualImpairedPerson": 0,
    "Deceased": 0,
    "Age": 53,
    "RegistryDate": "2019-05-02T20:32:12.931Z",
    "WageExpectation": "1111.32",
    "AreaOfInterestCode1": "15",
    "AreaOfInterestCode2": "15",
    "WageExpectationTradable": "1",
    "azerienceTime": "15",
    "WorkExperienceTimeArea1": "15",
    "WorkExperienceTimeArea2": "15",
    "ContraIndicated": "1",
    "ContraindicationReason": "string",
    "Available": "1",
    "FormOfRecruitment": "string",
    "ResumeSkillsId": "15",
    "HierarchyLevelCode": "15",
    "ProfessionalProfileDescription": "string",
    "AreaOfInterestDescription1": "string",
    "AreaOfInterestDescription2": "string",
    "HierarchyLevelDescription": "string",
    "ProfessionalSkillsResumeDescription": "string",
    "Employee1": "string",
    "PersonalEmail": "string",
    "MaritalState": "string",
    "Complement": "string",
    "ArrivalDate": "2019-05-02T20:32:12.931Z",
    "LetterModel19": "string",
    "Rne": "string",
    "ImmigrationDecree": "string",
    "RneExpirationDate": "2019-05-02T20:32:12.931Z",
    "WorkCardExpirationDate": "2019-05-02T20:32:12.931Z",
    "VisaType": "string",
    "PassportNumber": "string",
    "NativeCountry": "string",
    "PassportExpirationDate": "2019-05-02T20:32:12.931Z",
    "AccessibilityFeaturesForJobLocal": "string",
    "MilitaryDivision": "string",
    "MilitaryCertificateEmissionDate": "2019-05-02T20:32:12.931Z",
    "MilitaryCertificateEmitterAgency": "2019-05-02T20:32:12.931Z",
    "MilitaryRegion": "string",
    "MilitarySituation": "string",
    "ElectoralCardEmitterState": "string",
    "BloodType": "string",
    "Image": "string",
    "NeighborhoodTypeCode": "15",
    "NaturalnessCode": "string",
    "NaturalisationDate": "2019-05-02T20:32:12.931Z",
    "DriversLicenseEmitterAgency": "string",
    "RneEmitterAgency": "string",
    "CountryId": "1",
    "DeceaseDate": "2019-05-02T20:32:12.931Z",
    "DeathCertificateNumber": "string",
    "NaturalisationGatehouse": "string",
    "BrazilConditionClassification": "string",
    "DriversLicenseFirstEmissionDate": "2019-05-02T20:32:12.931Z",
    "FirstJobYear": "15"
}

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.


}


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ÇÃOFormato
companyId
Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchIdRFX_FILIALInformações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial"D MG 01 "
employeeIdRFX_MATMatrícula do Funcionário"000001"
startDateRFX_DATAIData de Início do Período"20200101"
stabilityCode

RFX_TPESTB

Tipo de Estabilidade"S01"

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 Validação

Erro

Mensagem

Solução

API RESPONSE

400

Erro na execução da Operação.

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

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "ERRO NA EXECUÇÃO DA OPERAÇÃO."
}
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.


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

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

Image Removed

Response 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.
stabilityId'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 de Período de Estabilidade:

  • endDate: Data do Final do Período 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/v2/StabilityControl

Image Added

Request da API:

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ÇÃOFormato
companyId
Informações de acesso ao sistema, campo contém informação do grupo de empresa
branchId
Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial
employeeIdRFX_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"
Propriedade API RESTCAMPO PROTHEUSDESCRIÇÃOFormato
companyIdInformaçõ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+ Filial
NameQG_NOMENome do Candidato"JOÃO PEREIRA  SILVA"
RegistryDateQG_DTCADData do Registro2019-05-02T20:32:12
DistrictQG_BAIRROBairroBARRA FUNDA
CityQG_MUNICIPMunicipSAO PAULO
StateQG_ESTADOEstadoSP
CepQG_CEPCep12345678
PhoneNumber1QG_FONEFonePhoneNumber2QG_FONECELFone CelularPhoneNumber3QG_FONECOMFone Comercial
identityNumberQG_RGRG123456789
CpfQG_CICCPF12345678900
WorkCardQG_NUMCPNum CPWorkCardSerialNumberQG_SERCPSerie CPWorkCardEmitterStateQG_UFCPUF CPDriversLicenseQG_HABILITHabilitaçãoMilitaryDischargeCertificateQG_RESERVReservistaElectoralCardQG_TITULOETitulo EleitorStreet + NumberQG_ENDERECEndereçoElectoralWard+ElectoralSectionQG_ZONASECZona Eleitoral
SexQG_SEXOSexoF - Feminino; M - Masculino.
MaritalStateQG_ESTCIVEstado Civil

C - Casado; D - Divorciado; M - União Estável; 
Q - Desquitado; S - Solteiro; V - Viúvo. 

HomeStateQG_NATURALNaturalidade - UFSP
NationalityQG_NACIONANacionalidade10
BirthQG_DTNASCData de Nascimento1900-01-01T01:01:01
"001" QG_SITUACSituac (Status Disponível)
EmailQG_EMAILEmail[email protected]
DisabledQG_DFISICODeficiente fisico

1- Sim; 2 - Não.

NaturalnessQG_MUNNASCNaturalidadeSAO PAULO
AreaOfInterestCode1QG_AREACódigo da área de interesse 1HierarchyLevelCodeQG_NIVHIERCódigo do nível hierárquicoWorkExperienceTimeQG_TPEXPERTempo de experiência profissional
WageExpectationQG_PRETSALPretensão Salarial1000.00
ArrivalDateQG_ANOCHEGData de chegada no Brasil1900-01-01T01:01:01
ProfessionalSkillsResumeDescriptionQG_MEMO2Descrição do resumo de qualificações

Erro

Mensagem

Solução

API RESPONSE

400

Erro genérico de operação.

Analisar disponibilidade de ambiente Protheus e revisar parametrização.

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "ERRO NA EXECUÇAO DA OPERAÇÃO."
}
400

Verificar se a propriedade (AreaOfInterestCode1)  possui cadastro no Protheus.

É necessário analisar o cadastro dentro do Protheus, para checagem se o código da área de interesse existe no Protheus, é possível checar pela própria tela de currículo.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "DE-PARA DE EMPRESA E FILIAL NÃO ENCONTRADO NA BASE PARA O COMPANYID E BRANCHID"
}
400

Erro de sistema.

Verificar disponibilidade de ambiente e arquivo console.log
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
  "errorMessage": "OCORREU UMA FALHA NO RETORNO DA INFORMAÇÃO."
}
Totvs custom tabs box items
defaultno
referenciaGET

Parâmetros de Entrada GET:

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.pagerequest da apiSimquery1
pageSizerequest da apiSimquery2000O Limite 
candidatesIdsT1|D RJ|123456789Simquery""Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|QG_FILIAL|QG_CIC", caso tenha mais de um candidato a ser consultado, se faz necessário adicionar "," e colocar o novo bloco. ex: "GRUPO DE EMPRESA|QG_FILIAL|QG_CIC,GRUPO DE EMPRESA|QG_FILIAL|QG_CIC"
Bloco de código
languagebash
themeEclipse
titleExemplo de Request da API
linenumberstrue
{
	"companyId":"T1",
	"branchId":"D MG 01",
    "id": "000001",
    "Name": "JOÃO PEREIRA DA SILVAI",
    "Birth": "01/01/1990",
    "HomeState": "MG",
    "Naturalness": "Belo Horizonte",
    "NickName": "Jão",
    "Sex": "M",
    "Nationality": "10",
    "EducationalLevel": "9",
    "Street": "Rua Mata Atlantica",
    "Number": "333",
    "District": "Planalto",
    "State": "MG",
    "City": "Belo Horizonte",
    "Cep": "30100020",
    "Country": "Brasil",
    "ProfessionalRegistrationNumber": "Reg-00098",
    "Cpf": "51427362653",
    "ImageId": 844,
    "PhoneNumber1": "4613636",
    "PhoneNumber2": "4613636",
    "identityNumber": "M 267392",
    "IdentityNumberEmitterState": "MG",
    "IdentityNumberEmitterAgency": "SSP",
    "IdentityNumberEmissionDate": "1993-04-25T00:00:00",
    "ElectoralCard": "123.334",
    "ElectoralWard": "0012",
    "ElectoralSection": "0006",
    "WorkCard": "015116",
    "WorkCardSerialNumber": "00001",
    "WorkCardEmitterState": "MG",
    "WorkCardEmissionDate": "1993-03-01T00:00:00",
    "Nit": 0,
    "DriversLicense": "13.344.543",
    "DriversLicenseType": "A",
    "DriversLicenseExpirationDate": "1997-02-05T00:00:00",
    "MilitaryDischargeCertificate": "12856945678",
    "MilitaryGrade": "CDI",
    "BrazilConsort": 0,
    "Naturalized": 0,
    "BrazilianChildren": 0,
    "BrazilianChildrenNumber": "2",
    "Email": "[email protected]",
    "PreviousTrainingInvestment": "2300.00",
    "ShadeRace": "0",
    "Disabled": 0,
    "UserCode": "simone",
    "PhoneNumber3": "21229000",
    "Company": "RM SISTEMAS S.A",
    "OccupationCode": "10",
    "Rehabilitated": 0,
    "Smoker": 0,
    "AdjustsImageSize": 0,
    "DeafPerson": 0,
    "MutePerson": 0,
    "BlindPerson": 0,
    "MentallyImpairedPerson": 0,
    "CurriculumApprovalDate": "2005-04-01T09:36:02.66",
    "Student": 1,
    "Teacher": 1,
    "Candidate": 1,
    "BibliosUser": 1,
    "Employee": 1,
    "FormerEmployee": 0,
    "IntellectualImpairedPerson": 0,
    "Deceased": 0,
    "Age": 53,
    "RegistryDate": "2019-05-02T20:32:12.931Z",
    "WageExpectation": "1111.32",
    "AreaOfInterestCode1": "15",
    "AreaOfInterestCode2": "15",
    "WageExpectationTradable": "1",
    "azerienceTime": "15",
    "WorkExperienceTimeArea1": "15",
    "WorkExperienceTimeArea2": "15",
    "ContraIndicated": "1",
    "ContraindicationReason": "string",
    "Available": "1",
    "FormOfRecruitment": "string",
    "ResumeSkillsId": "15",
    "HierarchyLevelCode": "15",
    "ProfessionalProfileDescription": "string",
    "AreaOfInterestDescription1": "string",
    "AreaOfInterestDescription2": "string",
    "HierarchyLevelDescription": "string",
    "ProfessionalSkillsResumeDescription": "string",
    "Employee1": "string",
    "PersonalEmail": "string",
    "MaritalState": "string",
    "Complement": "string",
    "ArrivalDate": "2019-05-02T20:32:12.931Z",
    "LetterModel19": "string",
    "Rne": "string",
    "ImmigrationDecree": "string",
    "RneExpirationDate": "2019-05-02T20:32:12.931Z",
    "WorkCardExpirationDate": "2019-05-02T20:32:12.931Z",
    "VisaType": "string",
    "PassportNumber": "string",
    "NativeCountry": "string",
    "PassportExpirationDate": "2019-05-02T20:32:12.931Z",
    "AccessibilityFeaturesForJobLocal": "string",
    "MilitaryDivision": "string",
    "MilitaryCertificateEmissionDate": "2019-05-02T20:32:12.931Z",
    "MilitaryCertificateEmitterAgency": "2019-05-02T20:32:12.931Z",
    "MilitaryRegion": "string",
    "MilitarySituation": "string",
    "ElectoralCardEmitterState": "string",
    "BloodType": "string",
    "Image": "string",
    "NeighborhoodTypeCode": "15",
    "NaturalnessCode": "string",
    "NaturalisationDate": "2019-05-02T20:32:12.931Z",
    "DriversLicenseEmitterAgency": "string",
    "RneEmitterAgency": "string",
    "CountryId": "1",
    "DeceaseDate": "2019-05-02T20:32:12.931Z",
    "DeathCertificateNumber": "string",
    "NaturalisationGatehouse": "string",
    "BrazilConditionClassification": "string",
    "DriversLicenseFirstEmissionDate": "2019-05-02T20:32:12.931Z",
    "FirstJobYear": "15"
}

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+ FilialNameQG_NOMENome do Candidato"JOÃO PEREIRA  SILVA"RegistryDateQG_DTCADData do Registro2019-05-02T20:32:12DistrictQG_BAIRROBairroBARRA FUNDACityQG_MUNICIPMunicipSAO PAULOStateQG_ESTADOEstadoSPCepQG_CEPCep12345678PhoneNumber1QG_FONEFonePhoneNumber2QG_FONECELFone CelularPhoneNumber3QG_FONECOMFone ComercialidentityNumberQG_RGRG123456789CpfQG_CICCPF12345678900WorkCardQG_NUMCPNum CPWorkCardSerialNumberQG_SERCPSerie CPWorkCardEmitterStateQG_UFCPUF CPDriversLicenseQG_HABILITHabilitaçãoMilitaryDischargeCertificateQG_RESERVReservistaElectoralCardQG_TITULOETitulo EleitorStreet + NumberQG_ENDERECEndereçoElectoralWard+ElectoralSectionQG_ZONASECZona EleitoralSexQG_SEXOSexoF - Feminino; M - Masculino.MaritalStateQG_ESTCIVEstado Civil

C - Casado; D - Divorciado; M - União Estável; 
Q - Desquitado; S - Solteiro; V - Viúvo. 

HomeStateQG_NATURALNaturalidade - UFSPNationalityQG_NACIONANacionalidade10BirthQG_DTNASCData de Nascimento1900-01-01T01:01:01"001" QG_SITUACSituac (Status Disponível)EmailQG_EMAILEmail[email protected]DisabledQG_DFISICODeficiente fisico

1- Sim; 2 - Não.

NaturalnessQG_MUNNASCNaturalidadeSAO PAULOAreaOfInterestCode1QG_AREACódigo da área de interesse 1HierarchyLevelCodeQG_NIVHIERCódigo do nível hierárquicoWorkExperienceTimeQG_TPEXPERTempo de experiência profissionalWageExpectationQG_PRETSALPretensão Salarial1000.00ArrivalDateQG_ANOCHEGData de chegada no Brasil1900-01-01T01:01:01ProfessionalSkillsResumeDescriptionQG_MEMO2Descrição do resumo de qualificações

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

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

Revisar a composição do parâmetro de candidatesIds

Erro

Mensagem

Solução

API RESPONSE

400

Erro na execução da Operação.

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

Erro

Mensagem

Solução

API RESPONSE

400

Problema com a parametrização para abertura de ambiente.

Revisar a composição do parâmetro de candidatesIds

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage":  ERRO AO PREPARAR O AMBIENTE COM A EMPRESA E FILIAL INFORMADOS!.\r\n"
}
400

Problema com parametrização para abertura de ambiente.

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": ""DE-PARA DE EMPRESA E FILIAL NÃO ENCONTRADO NA BASE PARA O COMPANYID E BRANCHID".\r\n: 400,
   "errorMessage": "ERRO NA EXECUÇÃO DA OPERAÇÃO."
}
400
500

Possíveis falhas genéricas no meio da busca por candidatos

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamenteRevisar parâmetros de requisição e se o ambiente protheus está disponível.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400500,
   "errorMessage": " "ERRO AONO BUSCARACESSO DADOS DO CURRÍCULO.\r\nAO 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.



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.
candidatesid
stabilityId'T1|D
RJ|123456789
MG 01|000001|20200101|S01'Simquery""

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

QG

RFX_FILIAL

|QG_CIC

|RFX_MAT|RFX_DATAI|RFX_TPESTB".

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta SOAP UI 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/v1v2/candidatesStabilityControl

Image RemovedImage Added

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

Tratamento de erros de integração Protheus:


Mensagens de Pré-Validação

Verificar a parametrização de empresa e filial no parâmetro candidatesid

Erro

Mensagem

Solução

API RESPONSE

400

Erro na execução da Operação.

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

Erro

Mensagem

Solução

API RESPONSE

400

Erro genérico de ambiente

Verificar parametrização enviada via api e se o ambiente está no ar. 

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "ERRO NA EXECUÇAO DA OPERAÇÃO."
}
400

Validação de empresa e filial

.

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400,
   "errorMessage": "DE-PARA DE EMPRESA E FILIAL NÃO ENCONTRADO ERRO NA BASEEXECUÇAO PARA O COMPANYID". STR0014: "E BRANCHID"DA OPERAÇÃO."
}
400
500

Falha no meio do processo de exclusão.

Erro no acesso ao Endpoint.

É necessário avaliar se o servidor está funcionando corretamente.verificar console.log, dados de empresa e filial.
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   "errorCode": 400500,
   "errorMessage": "OCORREU UMAERRO FALHA NO RETORNOACESSO DAAO INFORMAÇÃO.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.


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