01. DADOS GERAIS
| Produto: | TOTVS RH
|
|---|---|
| Linha de Produto: | Linha Protheus |
| Segmento: | RH |
| Módulo: | GESTÃO DE PESSOAS (SIGAGPE) |
| Função: | rh.sigagpe.ahgora.tlpp |
| Ticket: | |
| Requisito/Story/Issue (informe o requisito relacionado) : | DRHCALCPRT-16376 DRHCALCPRT-16377 DRHCALCPRT-16632 |
02. SITUAÇÃO/REQUISITO
Criação de API para integração das verbas e sindicatos para o Ponto Web da Ahgora.
03. SOLUÇÃO
Foram criadas as APIs 'ahgora/verbas' e 'ahgora/sindicatos', responsáveis por enviar as verbas e os sindicatos do Protheus para o Ponto Web da Ahgora.
Este método é responsável por enviar uma lista de verbas da tabela SRV do Protheus.
- Endpoint: api/rh/v1/ahgora/verbas?page=1&pageSize=500&cnpjList=1A23B45C678D90,14689130000198,82714573000141,73612881000175
- Método: GET
- Autenticação: Basic
Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | Numérico | Sim | Número da página a ser consultada (inicia em 1). |
pageSize | Numérico | Sim | Quantidade de registros por página. |
| cnpjList | String | Sim | CNPJs das filiais que serão consultadas na base do Protheus |
Importante
O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no protheus deve permitir esse acesso externo.
Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes.
Importante
Autenticação Basic: Enviar usuário e senha do Protheus no header da requisição.
Retorno
| Propriedades API | Descrição |
|---|---|
| cod | Código da Verba - RV_COD |
| desc | Descrição da Verba - RV_DESC |
| cnpj | CNPJ da filial - M0_CGC |
| categoria | Provento - Hora ou Dia; Desconto - Hora ou Dia; Base de Cálculo - Hora ou Dia; - RV_TIPOCOD + RV_TIPO |
Será retornado uma lista com as verbas referente ao CNPJ da filial que foi enviado na requisição e caso tenha algum erro será enviado no array de erros dentro do response
Operação realizada com sucesso!
{
"response": [
{
"erros": [
{
"mensagem": "CNPJ não encontrado na base de dados",
"cnpj": "1A.23B.45C/678D-90"
},
{
"mensagem": "CNPJ não encontrado na base de dados",
"cnpj": "1F.CFB.57C/9FG4-89"
},
{
"mensagem": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198",
"cnpj": "49.342.767/0001-98"
},
{
"mensagem": "Não existe cadastro de verbas para o CNPJ",
"cnpj": "53.113.791/0012-85"
}
],
"items": [
{
"cod": "002",
"desc": "PERICULOSIDADE",
"cnpj": "14.689.130/0001-98",
"categoria": "Provento - Hora"
},
{
"cod": "080",
"desc": "PERIC. FERIAS AVISO",
"cnpj": "14.689.130/0001-98",
"categoria": "Provento - Hora"
},
{
"cod": "419",
"desc": "Faltas",
"cnpj": "82.714.573/0001-41",
"categoria": "Desconto - Dia"
},
{
"cod": "759",
"desc": "H.E. DIA DSR",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo - Hora"
}
],
"hasNext": false
}
]
}
Caso ultrapasse a paginação que é 500 items por página, será enviado o hasNext com true, para prosseguir com a requisição
Operação realizada com sucesso!
{
"response": [
{
"erros": [],
"items": [
{
"cod": "002",
"desc": "PERICULOSIDADE",
"cnpj": "82.714.573/0001-41",
"categoria": "Provento - Hora"
},
{
"cod": "080",
"desc": "PERIC. FERIAS AVISO",
"cnpj": "82.714.573/0001-41",
"categoria": "Provento - Hora"
},
....
{
"cod": "460",
"desc": "HS. NAO COMPENSADAS",
"cnpj": "82.714.573/0001-41",
"categoria": "Desconto - Hora"
},
{
"cod": "759",
"desc": "H.E. DIA DSR",
"cnpj": "82.714.573/0001-41",
"categoria": "Base de Cálculo - Hora"
}
],
"hasNext": true
}
]
}
Verificar se todos os parâmetros foram passados na requisição
{
"code": 400,
"message": "Necessário enviar o page, pageSize e cnpjList na requisição""
}
Este método é responsável por enviar uma lista de sindicatos da tabela RCE do Protheus.
- Endpoint: api/rh/v1/ahgora/sindicatos?page=1&pageSize=500&cnpjList=1A23B45C678D90,14689130000198,82714573000141,73612881000175
- Método: GET
- Autenticação: Basic
Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | Numérico | Sim | Número da página a ser consultada (inicia em 1). |
pageSize | Numérico | Sim | Quantidade de registros por página. |
| cnpjList | String | Sim | CNPJs das filiais que serão consultadas na base do Protheus |
Importante
O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca dos sindicatos, seu REST no protheus deve permitir esse acesso externo.
Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes.
Importante
Autenticação Basic: Enviar usuário e senha do Protheus no header da requisição.
Retorno
| Propriedades API | Descrição |
|---|---|
| cod | Código do Sindicato - RCE_CODIGO |
| desc | Descrição do Sindicato - RCE_DESCRI |
| cnpj | CNPJ da filial - M0_CGC |
Será retornado uma lista com os sindicatos referente ao CNPJ da filial que foi enviado na requisição
Operação realizada com sucesso!
{
"response": [
{
"erros": [
{
"mensagem": "CNPJ não encontrado na base de dados",
"cnpj": "1A.23B.45C/678D-90"
},
{
"mensagem": "CNPJ não encontrado na base de dados",
"cnpj": "1F.CFB.57C/9FG4-89"
},
{
"mensagem": "Não existe cadastro de sindicatos para o CNPJ",
"cnpj": "53.113.791/0012-85"
}
],
"items": [
{
"cod": "00",
"desc": "SIND MEDIAS",
"cnpj": "53.113.791/0001-22"
},
{
"cod": "01",
"desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
"cnpj": "14.689.130/0001-98",
},
{
"cod": "51",
"desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
"cnpj": "14.689.130/0001-98",
},
{
"cod": "52",
"desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "53",
"desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "01",
"desc": "S001",
"cnpj": "82.714.573/0001-41",
}
],
"hasNext": false
}
]
}
Caso ultrapasse a paginação que é 500 items por página, será enviado o hasNext com true, para prosseguir com a requisição
Operação realizada com sucesso!
{
"response": [
{
"erros": [],
"items": [
{
"cod": "00",
"desc": "SIND MEDIAS",
"cnpj": "53.113.791/0001-22"
},
{
"cod": "01",
"desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
"cnpj": "14.689.130/0001-98",
},
{
"cod": "51",
"desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
"cnpj": "14.689.130/0001-98",
},
....
{
"cod": "52",
"desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "53",
"desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
"cnpj": "82.714.573/0001-41",
},
{
"cod": "01",
"desc": "S001",
"cnpj": "82.714.573/0001-41",
}
],
"hasNext": true
}
]
}
Verificar se todos os parâmetros foram passados na requisição
{
"code": 400,
"message": "Necessário enviar o page, pageSize e cnpjList na requisição""
}
04. DEMAIS INFORMAÇÕES
Não se aplica
05. ASSUNTOS RELACIONADOS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas