Dúvida
Como cadastrar uma pessoa no módulo Gestão de Pessoas utilizando API / Web Service via SoapUI ou Postman
Ambiente
- TOTVS RH - TOTVS RH (Linha RM) - TOTVS Folha de Pagamento - Todas as versões
Solução
Para cadastrar uma pessoa no RM via WebService/API, utiliza-se o DataServer RhuPessoaData. Para mais detalhes sobre esse DataServer, consulte a documentação oficial:
🔗 [RhuPessoaData - Documentação Oficial]
Antes de cadastrar uma nova pessoa, recomenda-se consultar os dados de uma pessoa já existente. Isso retorna um XML ou JSON pronto, que pode ser utilizado como base para o cadastro de uma nova pessoa.
Abaixo, exemplificamos esse processo utilizando as ferramentas SoapUI e Postman:
1- Consulta e cadastro via SoapUI
2- Consulta e cadastro via Postman
1. Consulta e cadastro via SoapUI
Passo 1 – Realizar um ReadRecord
Para realizar a leitura dos dados de uma pessoa já cadastrada, utilize o método ReadRecord, fornecendo as seguintes informações:
DataServer: RhuPessoaData
Chaves primárias:
CODCOLIGADA (código da coligada da pessoa)
CODPESSOA (ID da pessoa que será consultada)
Parâmetros de contexto:
CODCOLIGADA
- CODUSUARIO
OBS: Lembre-se de colocar a autenticação (basic), no canto inferior esquerdo
2. Em seguida, será necessário obter o XML gerado após o consumo do DataServer. Para isso, deve-se acessar a aba XML e extrair as informações disponíveis na tag "ReadRecordResult", conforme o exemplo abaixo:
3. Após copiar o XML, vamos acessar o método SaveRecord e informar o DataServer em questão (RhuPessoaData), o XML que copiamos e também o contexto da mesma forma que fizemos no ReadRecord, conforme o exemplo a baixo:
OBS: Não se esqueça de fechar as chaves no final do XML.
4. Em quarto passo você deve alterar as informações base para as informações da nova pessoa que será cadastrada, se atente ao formato que as tags pedem para serem inseridas, conforme está na documentação do DataServer.
2. Consulta e cadastro via Postman
-
Assim como no SOAP, o primeiro passo é obter as informações do JSON base para realizar o envio. Para isso, deve-se utilizar a URL do exemplo abaixo e informar o DataServer correspondente no método GET.
Além disso, é necessário aplicar um filtro por ID, pois, caso o GET seja executado sem filtros, todos os funcionários serão retornados por padrão. Isso pode impactar o desempenho e resultar em alguns campos sendo carregados como nulos. Portanto, a aplicação de um filtro por ID é essencial para garantir que todos os campos sejam retornados corretamente, com as informações completas para nossa base.
2. Após essa etapa, copie apenas as informações que antecedem a chave "{" da tag "id" e finalize a cópia ao final dessa chave. É importante extrair apenas os dados da PPESSOA, sem incluir outras tabelas, como VLCOMPL ou PFCOMPL, pois essas não precisam ser copiadas.
3. Após copiar os dados base utilizando o método GET, é necessário alterar o método para POST e informar no body o JSON base copiado.
Diferente do GET, no POST não é necessário informar o ID nem aplicar um filtro.
Ao finalizar a estrutura do JSON, certifique-se de incluir a chave de fechamento corretamente e garantir que não haja uma vírgula antes dessa chave, evitando erros de formatação.
Segue um exemplo abaixo:
4. Em quarto passo você deve alterar as informações base para as informações do novo funcionário que será cadastrado, se atente ao formato que as tags pedem para serem inseridas, por isso tomamos como base o Json de outro funcionário. Feito as alterações pode consumir normalmente.
Saiba mais
Cross Segmentos - Backoffice RM - Integração - WebServices - Lista de DataServers Web Services
0 Comentários