Linha RM

Atalhos

Páginas filhas
  • DT - Integração RM X Ahgora - API de Sindicato

Versões comparadas

Versão antiga 21

changes.mady.by.user Simone Cristina Dos Reis

Gravado em

comparado com

Nova versão 22

changes.mady.by.user Simone Cristina Dos Reis

Gravado em

Chave

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

1. DADOS GERAIS

Produto:

RM

Linha de Produto:

Linha RM

Segmento:

RH

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).

pageSizeNuméricoSimQuantidade de registros por página.
cnpjListStringSimCNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM



Nota
titleImportante:

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
titleAtenção:

Autenticação Basic: Enviar usuário e senha do RM no header da requisição.


Retorno

Deck of Cards
startHiddenfalse
idretorno
Card
defaulttrue
id200ok
label200 - OK
titleSucesso
Propriedades APIDescrição
codCódigo do Sindicato - PSINDIC.CODIGO
descDescrição do Sindicato - PSINDIC.NOME
cnpjCNPJ da Coligada- GCOLIGADA.CGC


Será retornado uma lista com os sindicatos referente ao CNPJ da coligada que foi enviado na requisição.

Bloco de código
languagejs
themeConfluence
titleOperação realizada com sucesso!
linenumberstrue
{
    "response": [
        {
            "erros": [
                {
                    "mensagem": "05.295.401/0001-30",
                    "cnpj": "Necessário ativar a integração."
                },
                {
                    "mensagem": "07.363.764/0001-90",
                    "cnpj": "Coligada não existe."
                }
            ],
            "items": [
                {
                    "cod": "0001",
                    "desc": "SINDADOS",
                    "cnpj": "07.577.599/0001-70"
                },
                {
                    "cod": "0002",
                    "desc": "SINDICATO COMERCIO",
                    "cnpj": "07.577.599/0001-70"
                },
                {
                    "cod": "0003",
                    "desc": "SINDICATO DOS ADMINISTRADORES DE EMPRESA",
                    "cnpj": "07.577.599/0001-70"
                }
            ],
            "hasNext": false
        }
    ]
}



Informações
titleImportante:

Caso o número de itens ultrapasse o limite da página, o campo hasNext será retornado como true, indicando que há mais dados a serem requisitados.
O recomendável é solicitar 500 itens por página.

Card
id400bas
label400 - Solicitação inválida
titleBody

Verificar se todos os parâmetros foram passados na requisição

Bloco de código
languagejs
themeConfluence
linenumberstrue
{
    "code": "FE016",
    "message": "O campo CnpjList é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora