1. DADOS GERAIS
| Produto: | |
|---|
| Linha de Produto: | |
|---|
| Segmento: | |
|---|
| Módulo: | TOTVS Folha de Pagamento |
|---|
| Função: | Integração RM X Ahgora - API de Sindicato |
|---|
| País: | Brasil |
|---|
| Requisito/Story/Issue (informe o requisito relacionado) : | DRHROTRM-13584 |
|---|
02. LIBERAÇÃO
Lembrando que, será a partir dos patches:
- 12.1.2410.xxx
- 12.1.2502.xxx
- 12.1.2506 e superiores
03. SITUAÇÃO/REQUISITO
Criação de API para integração dos dados dos sindicatos para o Ponto Web da Ahgora.
04. SOLUÇÃO
Visando otimizar a integração entre os sistemas, foi disponibilizada a API ahgora/sindicatos. Essa API é responsável por enviar automaticamente as informações dos Sindicatos cadastradas na Folha de Pagamento para o Ponto Web da Ahgora, garantindo mais agilidade, padronização e segurança no compartilhamento de informações.
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='CNPJ da COLIGADA'
- 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 | CNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM |
| Nota |
|---|
|
O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no RM 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. |
| Informações |
|---|
|
Autenticação Basic: Enviar usuário e senha do RM no header da requisição. |
Retorno
| Deck of Cards |
|---|
| startHidden | false |
|---|
| id | retorno |
|---|
|
| Card |
|---|
| default | true |
|---|
| id | 200ok |
|---|
| label | 200 - OK |
|---|
| title | Sucesso |
|---|
| | Propriedades API | Descrição |
|---|
| cod | Código do Sindicato - PSINDIC | | desc | Descrição do Sindicato - PSINDIC.DESCRICAO | | cnpj | CNPJ da Coligada- GCOLIGADA.CGC |
Será retornado uma lista com os sindicatos referente ao CNPJ da filial que foi enviado na requisição | Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | 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 | Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | 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
}
]
} |
|
| Card |
|---|
| id | 400bas |
|---|
| label | 400 - Solicitação inválida |
|---|
| title | Body |
|---|
| Verificar se todos os parâmetros foram passados na requisição | Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| {
"code": 400,
"message": "Necessário enviar o page, pageSize e cnpjList na requisição""
} |
|
|
