Histórico da Página

Integrações Clock In - api/rh/v1/DbHrClockin

API responsável por retornar o total de marcações no Clock In, total de marcações integradas, total de marcações a serem integradas e o total de marcações sem NSR gerada.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

• Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

• Protheus com sua arquitetura devidamente estruturada.

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 da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para trazer o total de funcionários que estão com o ponto completo e o total de funcionários com o ponto incompleto.

Cadastro

Esta API contempla as consultas de marcações do Clock In e marcações integradas com o ERP.

Processos

O Dashboard RH realizará o consumo da API para buscar e exibir a quantidade total de marcações no Clock In, total de marcações integradas, total de marcações a serem integradas e o total de marcações sem NSR gerada.

Como realizar a chamada da API REST

• Preenchimento do EndPoint da API PONAPIDSB;
• Utilizar a chamada do método POST e do Serviço api/rh/v1/DbHrClockin;
• Preenchimento dos parâmetros obrigatórios da API;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD

Parâmetros de Entrada:

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}:{porta}/{endereço Rest}/api/rh/v1/DbHrClockin

Response da API:

Application/json

{
    "1": {
 2,
                "dateTime": "01/03/2023 12:00"
            },
            {
                "cnpj": "99999999999999",
                "cpf": "88888888888",
                "pis": "77777777777",
                "branch": "Filial B",
                "name": "Func B",
                "device": "dispositivo B",
                "nsr": 0,
                "dateTime": "01/03/2023 13:00"
            }
        ],
        "totalIntegrated": 1,
        "integratedDetails": [
            {
                "cnpj": "99999999999999",
                "cpf": "88888888888",
                "pis": "77777777777",
                "branch": "Filial B",
                "namebranch": "Func BTodas",
        "totalClockMarkings": 7,
        "devicetotalDetails": "dispositivo B", [
            {
                "nsrcnpj": 1"99999999999999",
                "dateTimecpf": "01/03/2023 09:00"
44379500039",
                "pis": "61743152540",
                "branch": "Filial A",
                }
 "name": "Func A",
            ]    "device": "dispositivo A",
        "totalToBeIntegrated        "nsr": 1,
                "toBeIntegratedDetailsdateTime": ["01/03/2023 09:00"
            },
            {
                "cnpj": "99999999999999",
                "cpf": "8888888888844379500039",
                "pis": "7777777777761743152540",
                "branch": "Filial BA",
                "name": "Func BA",
                "device": "dispositivo BA",
                "nsr": 2,
                "dateTime": "01/03/2023 12:00"
            },
        ],
    {
      "totalWhitoutNSR": 1,
        "whitoutnsrDetails": [
            {
                "cnpj": "99999999999999",
                "cpf": "8888888888844379500039",
                "pis": "7777777777761743152540",
                "branch": "Filial BA",
                "name": "Func BA",
                "device": "dispositivo BA",
                "nsr": 03,
                "dateTime": "01/03/2023 13:00"
            },
        ]
    }
}

Observação

Caso os indicadores não possuam dados a serem exibido, será necessário enviar no retorno da API as propriedades da resposta com 0 e o detalhamento com um array vazio. Exemplo:

{
    "1": {
            "branchcnpj": "Todas as Filiais99999999999999",
        "totalClockMarkings": 0,
        "totalDetailscpf": []"44379500039",
        "totalIntegrated": 0,
        "integratedDetailspis": []"61743152540",
        "totalToBeIntegrated": 0,
        "toBeIntegratedDetailsbranch": [] "Filial A",
        "totalWhitoutNSR": 0,
        "whitoutNsrDetailsname": []"Func A",
    },
	"2": {
            "branchdevice": "Filialdispositivo A",
        "totalClockMarkings": 0,
        "totalDetailsnsr": []0,
        "totalIntegrated": 0,
        "integratedDetailsdateTime": [],
"01/03/2023 18:00"
          "totalToBeIntegrated": 0  },
        "toBeIntegratedDetails": [],    {
        "totalWhitoutNSR": 0,
        "whitoutNsrDetailscnpj": []
"99999999999999",
       },
	"3": {
        "branchcpf": "Filial B88888888888",
        "totalClockMarkings": 0,
        "totalDetailspis": []"77777777777",
        "totalIntegrated": 0,
        "integratedDetailsbranch": []"Filial B",
        "totalToBeIntegrated": 0,
        "toBeIntegratedDetailsname": [] "Func B",
        "totalWhitoutNSR": 0,
          "whitoutNsrDetailsdevice": []"dispositivo B",
    }
}

Observação

Caso seja selecionada 2 ou mais filiais, a primeira posição da resposta obrigatoriamente será o totalizador, para a demais posições serão as filiais e suas informações.
Se for selecionado apenas 1 filial no filtro só haverá 1 posição na resposta da API.

Chamada API:
Image Removed

Possíveis situações no envio dos filtros

{
    "startDate":"2023-03-01",
    "endDate":"2023-03-31",
    "branchesnsr":[ 1,
        "todas"
    ]
}

{
    "startDatedateTime": "2023-03-01",
01/03/2023 09:00"
     "endDate":"2023-03-31",
    "branches":[
       },
            {
                "cnpj": "99999999999999",
                "cpf": "88888888888",
          "D MG 01"      "pis": "77777777777",
    ]
}

{
            "startDatebranch":"2023-03-01 "Filial B",
         "endDate       "name":"2023-03-31 "Func B",
       "branches":[
         "device"D: MG"dispositivo 01B",
        "M  SP 01"
    ]
}

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.

Mensagens de Pré-Validação

{
    "1": {
        "branch": "Todas as Filiais",
        "totalClockMarkings": 0,
        "totalDetails": [],
        "totalIntegrated": 0,
        "integratedDetails": [],
        "totalToBeIntegrated": 0,
        "toBeIntegratedDetails": [],
        "totalWhitoutNSR": 0,
        "whitoutNsrDetails": []
    },
	"2": {
        "branch": "Filial A",
        "totalClockMarkings": 0,
        "totalDetails": [],
        "totalIntegrated": 0,
        "integratedDetails": [],
        "totalToBeIntegrated": 0,
        "toBeIntegratedDetails": [],
        "totalWhitoutNSR": 0,
        "whitoutNsrDetails": []
    },
	"3": {
        "branch": "Filial B",
        "totalClockMarkings": 0,
        "totalDetails": [],
        "totalIntegrated": 0,
        "integratedDetails": [],
        "totalToBeIntegrated": 0,
        "toBeIntegratedDetails": [],
        "totalWhitoutNSR": 0,
        "whitoutNsrDetails": []
    }
}

{
    "startDate":"2024-01-01",
    "endDate":"2024-01-05",
    "branches":[
        "todas"
    ]
}

{
    "startDate":"2024-01-01",
    "endDate":"2024-01-05",
    "branches":[
        "D MG 01"
    ]
}

{
    "startDate":"2024-01-01",
    "endDate":"2024-01-05",
    "branches":[
        "D MG 01",
        "M SP 01"
    ]
}

Integrações Clock In - api/rh/v1/DbHrEmail

API responsável por enviar um e-mail com um HTML que é uma cópia do Dashboard e uma planilha do excel contendo os dados dos indicadores.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

• Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

• Protheus com sua arquitetura devidamente estruturada.

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 da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para enviar as informações exibidas no Dashboard RH por e-mail.

Cadastro

Esta API contempla os resultados das informações exibidas no Dashboard RH, no caso o resultado das APIs anteriores (DbHrAttendanceControl e DbHrClockin). 

Processos

O Dashboard RH realizará o consumo da API para enviar um e-mail, contendo um HTML do Dashboard RH anexa.

Como realizar a chamada da API REST

• Preenchimento do EndPoint da API PONAPIDSB;
• Utilizar a chamada do método POST e do Serviço api/rh/v1/DbHrEmail;
• Preenchimento dos parâmetros obrigatórios da API;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD

Parâmetros de Entrada:

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}:{porta}/{endereço Rest}/api/rh/v1/DbHrEmail

Response da API:

Application/json
{
   "Response": "E-mail enviado com sucesso."
}

Para o envio do e-mail com os dados do Dashboard será necessário verificar se o e-mail deverá ser enviado para o gestor ou não, através do parâmetro sendToManager, caso ele esteja true o e-mail deverá ser separado por gestor, assim como os dados do dashboard, caso ele esteja com false o e-mail será enviado para um único destinatário, configurado no parâmetro do Protheus.

sendToManager envio do e-mail para os gestores:
Image Added

Json completo com o parâmetro sendToManager = true

Exemplo 1º posição:
Image Added

Exemplo 2º posição:
Image Added

sendToManager envio do e-mail para o parâmetro (não para os gestores):
Image Added

Json completo com o parâmetro sendToManager = false

Situações de Erros Tratados

O envio de dado inesperado no parâmetro 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.

Mensagens de Pré-Validação

Filiais - api/rh/v1/DbHrGetExcel

API responsável por gerar os dados do Dashboard RH em uma planilha do Excel.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

• Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

• Protheus com sua arquitetura devidamente estruturada.

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 da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para gerar uma planilha do Excel contendo os dados do Dashboard RH.

Cadastro

Esta API contempla os resultados das informações exibidas no Dashboard RH, no caso o resultado das APIs anteriores (DbHrAttendanceControl e DbHrClockin). 

Processos

O Dashboard RH irá enviar para a API os dados dos indicadores e terá como retorno uma planilha do Excel.

Como realizar a chamada da API REST

• Preenchimento do EndPoint da API PONAPIDSB;
• Utilizar a chamada do método POST e do Serviço api/rh/v1/DbHrGetExcel;
• Preenchimento dos parâmetros obrigatórios da API;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD

Parâmetros de Entrada:

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}:{porta}/{endereço Rest}/api/rh/v1/DbHrGetExcel

Response da API:

Application/json

{
 "fileName": "dashboard_rh.xlsx",
 "file":"UEsDBBQAAAAIAAAAIQDV8zb9WAEAAJ8FAAATAAAAW0NvbnRlbnRfVHlwZXNdLnhtbM2Uy27CMBBF9/2KyNsqMVCpqioCiz6WLVLpB7j2hFg4tuUZKPx9nQRQW/EUSO0mVjx37rljJe4PF5VJ5hBQO5uzbtZhCVjplLaTnL2Pn9M7liAJq4RxFnK2BGTDwVV/vPSASWy2mLOSyN9zjrKESmDmPNhYKVyoBMXXMOFeyKmYAO91OrdcOktgKaXagw36j1CImaHkaRG32yABDLLkoRXWrJwJ742WgmKdz636RUlXhCx2NhostcfrKGB8K6Gu7Aas+l7jyQStIBmJQC+iiiqunBwF55FHfbbfZUtMVxRaQvSYVbElgzqQApX6aAmBNGwy72VLF+B0+PqM6u4jiQvDkZYG8OxR0QcQCksAqkzWmh4gU/yeoH12z+Y3NgeAny5MP5ybXnrYes0qoe0R/EaMvFnOn/pnkI3/iTl6/yTHzR/lwFIEUG8U4rV48T/hu/c6B2/u18EXUEsDBBQAAAAIAAAAIQDyn0na6QAAAEsCAAALAAAAX3JlbHMvLnJlbHOtksFOwzAMQO98ReT7mm5ICKGluyCk3SY0PsAkbhu1jaPEg+7viZBADI1pB45x7Odny+vNPI3qjVL2HAwsqxoUBcvOh87Ay/5pcQ8qCwaHIwcycKQMm+Zm/UwjSqnJvY9ZFUjIBnqR+KB1tj1NmCuOFMpPy2lCKc/U6Yh2wI70qq7vdPrJgOaEqbbOQNq6Jaj9MdI1bG5bb+mR7WGiIGda/MooZEwdiYF51O+chlfmoSpQ0OddVte7/D2nnkjQoaC2nGgRU6lO4stav3Uc210J58+MS0K3/7kcmoWCI3dZCWP8MtInN9B8AFBLAwQUAAAACAAAACEAFLh0yPcAAADTAwAAGgAAAHhsL19yZWxzL3dvcmtib29rLnhtbC5yZWxzvZPNasMwEITvfQqx91i204ZQIudSCrm26QMIa/1DbElotz9++4qEpg4Ek4PJScyInflA2s32p+/EFwZqnVWQJSkItKUzra0VfOxfF2sQxNoa3TmLCgYk2BYPmzfsNMcZalpPIoZYUtAw+2cpqWyw15Q4jzbeVC70mqMMtfS6POgaZZ6mKxnGGVBcZIqdURB2JgOxHzzeku2qqi3xxZWfPVq+UiG/XThQg8gxVIcaWcHZInk8siSmgrwOk98ZJp+CWd4ZZjkF8zgnDMdZ/Ac5ypM5+TpPczIQD1386meIk56qX81a3+iA5p1D3MMxxdj+g5EXu1j8AlBLAwQUAAAACAAAACEARbwgcM8CAADDCgAAGAAAAHhsL3dvcmtzaGVldHMvc2hlZXQxLnhtbJWWTXPaMBCG7/0VGt2LjY2BMEAmATztoTOdph9nxZZBE9vySCK0/fWVZZeP1abQC9ir513tqzV45/c/q5K8cqWFrBd0OAgp4XUmc1FvF/Tb1/T9lBJtWJ2zUtZ8QX9xTe+X7+YHqV70jnNDbIJaL+jOmGYWBDrb8YrpgWx4bVcKqSpm7K3aBrpRnOVOVJVBFIbjoGKipl2GmbolhywKkfG1zPYVr02XRPGSGVu+3olG0+U8F3at9UMULxb0YThLpzRYzt3O3wU/6LNrYtjzEy95Znhu/VPSGnuW8qVd/GhDYSsNPG3qivqsSM4Lti/NF3n4wMV2Z2ySpJVkstTuk1Sidpkr9rPbQeRmZ6/CwWQY3sWThJJsr42sfvQLvbwTRr0wOgnjm4RxL4yPwtFtO4564egojJKbhEkvTP53x3EvHJ88Tv4lDLrDdY1YM8OWcyUPRLnT1Q1rH8fhbGwfhawNPrRRt2ab0z4gr8vxPHht0/TEY0dErqg2sIKBNQxsYCA9CwS2nGNNEVpT1NOnmkJQk08ML4mVT0SXxNon4kti4xOjSyL1ieRIXBiNUaOxk8dn8gkw6hNTYNQn7oBRnxiC89wgCDjQFEEi3OsI9Try9eC8HxEEHPgKQRJgF0HAI71BEHDwKYK8YTdB7SZXW+sTQ9hbBIHNRRDYXASBzfWRKMTdjlG34+vN9RHo1iciUOca2Qf2FkFgb5GN3nA7Qd1OrvbWJyLw97NCEHBkax/xeosgsLfIRiPc7RR1O73eWwSBzfWRCP5wkSywuQgCm4tsBO0GZy9HtjcyFaXhqp+Iolnq3lMVV1u+4mWpSSb3dTu70LPoaX7q3ronfDlv2JZ/Ymorak1KXph2UCKqG4DslZGN+36Wxr673eXODn/cVh8ObOGFlObvTdBle+Jm35CGNVw9id921LyjRCphxzw33S1oI5VRTBhXy3H+XP4BUEsDBBQAAAAIAAAAIQC0aXYXmwIAAPIIAAAYAAAAeGwvd29ya3NoZWV0cy9zaGVldDIueG1slZZLc9sgEMfv/RQM91pPP0dSJn7FPnSm0/RxJhKymEhCAzhO++kLSLEtxEG5WLD8/rC7rIHo4b0qwRtmnNA6ht7EhQDXKc1IfYrhr5/7rwsIuEB1hkpa4xj+xRw+JF+iC2WvvMBYADlBzWNYCNGsHIenBa4Qn9AG13Ikp6xCQnbZyeENwyjToqp0fNedORUiNWxnWLExc9A8Jyne0vRc4Vq0kzBcIiHd5wVpOEyijMgxFQ9gOI/ho7c6htBJIr3yb4Iv/K4NVCAvlL6qzjGLoatQZ8DutRPfGchwjs6l+EEvB0xOhZBJmypJSkuuf0FFVCYhqNC7/l5IJgrZcidzz10G8ykE6ZkLWv3pBjp5K/Q7oX8TBqOEQScMrsJw3IphJwyvQn86SjjthNObq94o4awTzm4rjnN13gnnn41x0QkXnxUuO+FypNBp60DXzBYJlESMXgDThcAbpP4p3mopqzRVxkdl1WOyjlTtviWBGzlvap4OWbeIr71Sho1p2JqGnWnYm4Yn03AwDcc7gyNDuMbhW+PwO/oWhxnGkPD6xGZI+H1iOySCPrGzzDHrI3sLMu8jTxZk0UcOFmTZR45DJLwSvZQG1pQGWh7cyQ0310PCM9zcWBDDza0FMfZuN0QCY/P2FsTYvScLYmzf4QO5VqHFOc+exNCaxHCoN9ZcDxEziUPCN8LfWtYx6m43RILQSKIFMZNoQaZGEkMziRbn5kYSnbsDC50F3ZNSYNZdoP7qqM+BCrMT3uCy5CCl51pdffDOertu25PwhidRg074G2InUnNQ4lyoexaw9v6ULUEb/X2hQp6nulnItwKW3rsT6XhOqfjoOO1sz1icG9CgBrNn8g/rE5oyIl8F+jEQw4YywRAR2pfrcyX5D1BLAwQUAAAACAAAACEA1umMcTUCAABqBgAAGAAAAHhsL3dvcmtzaGVldHMvc2hlZXQzLnhtbJWV246bMBCG7/sUlu8bE3IkAlbbZLPJRaVVt4drLwxgLWBkm2Tbp69t3BxIVCU3YP/+v7HHGobw4aMq0Q6EZLyO8HDgYQR1wlNW5xH+8X39eY6RVLROaclriPBvkPgh/hTuuXiXBYBCOkAtI1wo1SwIkUkBFZUD3kCtVzIuKqr0VORENgJoaqGqJL7nTUlFWY27CAtxSwyeZSyBFU/aCmrVBRFQUqWPLwvWSByHKdNrJh8kIIvw43Cx9TGJQ7vzTwZ7eTJGJpE3zt/NZJtG2DNWcuFd20O8CJRCRttSfeP7DbC8UPrSJgZJeCntE1XM3CRGFf2w7z1LVaFH/mA29ILRbIJR0krFq19uweEd6DvQvxccOXB0Lzh24PgIejeBEwdODuD4NnDqwOm94MyBs3tznDtwfgD90U1g4MDgCP73qKSrA1szK6poHAq+R8IWgmyo+VKGi0BXaWLER6PaNV1HpnZ38dgPyc7EcZYvncVWsBWWfWHVF576wrovPPeFTV/YnghEp3DIw7+ah+/cxzxG014eVyyzc8vyimV+blldWrxzx9Olo3ej6yvbBOeW50vLuLfP5opleG7ZXlomB0d3qeSkUGir+JqVCoRrXL5rXBWIHJZQlhIlvK1Ny8En6rHNdRV4tMdhQ3P4SkXOaolKyJTpb0h0fUuPFG/s+40rXcd2WOgeDfrw3kA3koxz9W9CumivoNoGNbQB8cr+gP0yuGC6G9smHOGGCyUoU/Ysh99E/BdQSwMEFAAAAAgAAAAhAD9AehHbAQAAKwQAAA8AAAB4bC93b3JrYm9vay54bWytUl1v0zAUfedXGKvSnmg+1ka0ajLBRkUkBJMY2+PkxTeNVceObId0P2e/hT/GdUpGsjEJIZ7se+Nzzj33ZHN2qCX5DsYKrVIazUNKQBWaC7VL6ber7Zu3lFjHFGdSK0jpPVh6lr3adNrs77TeE8Qrm9LKuWYdBLaooGZ2rhtQ+KXUpmYOS7MLbGOAcVsBuFoGcRgmQc2EokeGtfkbDl2WooALXbQ1KHckMSCZw+ltJRpLs00pJFwfDRHWNJ9ZjWMfJCWSWfeBCwc8pQssdQeThmmb962QvliGSxpkjyYvDeFQsla6KxxtYMd1xYs4TvxL/+paQGd/g3xJDjdCcd2lNF7gZu+HKlpS0vX3G8FdhY0kXD32PoLYVS6lqyQJPXkwYu/3N5xE9eZyxUXBuDZgybZVBc7248EIbTE6/yxHSxH6Wwu8mJxHnnRMcKmV05bkGHzdSHATZDxCxk+RY+lzqYs9koywpyPsaW9lmB/3KRRwn860+kV8e5Cqnt9uhXRgLphjd8yCD61g8utotEpwDj4Kmp38aZiT17N3s3g9y2fxJhjJ/LNm+LLmZPeD8PZ/CUdT4eeZvWw1mG4bWQv8pf3RE8eLZbSipGylPMfeF/VJs17QBzb8ztlPUEsDBBQAAAAIAAAAIQA8USK29AEAAKcFAAAUAAAAeGwvc2hhcmVkU3RyaW5ncy54bWyFVEtu2zAQ3fcUA+4TyZ80TiArMBT/ikoWJPcAA5mNiUqkSlJG29sUWRQo0GVP4IuVrg3E1VipNgPN973HIYOHL1UJO66NUHLMetc+Ay4LtRHyacw+rGdXIwbGotxgqSQfs6/csIfwTWCMBVcqzZhtra3vPc8UW16huVY1ly7yUekKrfvVT56pNceN2XJuq9Lr+/5br0IhGRSqkXbMbu8YNFJ8bnh0dAwHLAyMCAMbzkQpsAw8GwbewXP0xmj1/lfRlNiOzBpZOC7771qoduyR16gtVlxaEptzY5Vue3OLtjG0j8Vye+wDG2XgfCjNhngOfq/t9g/fgCRP8gWkyRqiVZy+n65XMFsmkySaLrMVodoZmU/z9So7K4UDiHZWqg74C1XVJaeCxJCnXbD7/4edLdo51HOCmS3gMOzipGHnpGVymvWKQkeGQnZxpM0uAf8L5KazNp/GEE+y6BUcOa+gQl3g/sf+N6cbQlpREI9oya7HyoodIZVqvhOGks04luIbbkhgVSit9z/dCqOBKziKtuwUzb/x/J67xX16NgLBnFF9prV3977vZvT6Jzs42ZGzJHnYNcgftcqHJ3t7oU2UpO+IL50R2ZY55WNqZcQlkZM8u3RCsFAaIe7k/+/L4eSOX7bCvSQQlar45LR/qfPcSxv+AVBLAwQUAAAACAAAACEAP9jvIbEFAABTGwAAEwAAAHhsL3RoZW1lL3RoZW1lMS54bWztWU2P00YYvvMrRr6D48QO2RVZtMkm0MLCajdQcZzYE3vI2GPNTHbJrYJjpUpVadVLpd56qNoigdQL/TXbUrVU4i/09UeS8WayZGGrFkEOiWf8vN8ffse5cvVBzNAhEZLypG05l2oWIonPA5qEbevOoH+xZSGpcBJgxhPStqZEWle3LlzBmyoiMUFAnshN3LYipdJN25Y+bGN5iackgXsjLmKsYClCOxD4CNjGzK7Xak07xjSxUIJj4Hp7NKI+QYOMpbU1Y95j8JUomW34TBz4uUSdIscGYyf7kVPZZQIdYta2QE7AjwbkgbIQw1LBjbZVyz+WvXXFnhMxtYJWo+vnn5KuJAjG9ZxOhMM5odN3Ny7vzPnXC/7LuF6v1+05c345APs+WOosYd1+y+nMeGqg4nKZd7fm1dwqXuPfWMJvdDodb6OCbyzw7hK+VWu62/UK3l3gvWX9O9vdbrOC9xb45hK+f3mj6VbxOShiNBkvobN4ziMzh4w4u26EtwDemiXAAmVr2VXQJ2pVrsX4Phd9AOTBxYomSE1TMsI+4Lo4HgqKMwF4k2DtTrHly6WtTBaSvqCpalsfpxgqYgF59fzHV8+folfPnxw/fHb88JfjR4+OH/5sILyOk1AnfPn9F39/+yn66+l3Lx9/ZcZLHf/7T5/99uuXZqDSgS++fvLHsycvvvn8zx8eG+DbAg91+IDGRKJb5Ajt8xhsMwggQ3E2ikGEaYUCR4A0AHsqqgBvTTEz4Tqk6ry7AhqACXhtcr+i60EkJooagDeiuALc5Zx1uDCacyOTpZszSUKzcDHRcfsYH5pkd0+EtjdJIZOpiWU3IhU19xhEG4ckIQpl9/iYEAPZPUorft2lvuCSjxS6R1EHU6NLBnSozETXaQxxmZoUhFBXfLN7F3U4M7HfIYdVJBQEZiaWhFXceA1PFI6NGuOY6cibWEUmJQ+mwq84XCqIdEgYR72ASGmiuS2mFXVvYOhExrDvsmlcRQpFxybkTcy5jtzh426E49SoM00iHfuRHEOKYrTHlVEJXq2QbA1xwMnKcN+lRJ2trO/QMDInSHZnIsquXem/MU1Oa8aMQjf+0Ixn8G14NJlK4mQLXoV7BxvvDp4kewRy/UPf/dB338e+u6qW1+22iwZr63Nxzi9eOSSPKGMHasrITZm3ZglKB33YzBc50XwmTyO4LMVVcKHA+TUSXH1CVXQQ4RTEOLmEUJasQ4lSLuEkYK3knR8nKRif73mzMyCgsdrlQbHd0M+Gczb5KpS6oEbGYF1hjctvJ8wpgGtKczyzNO9UabbmTagGhLODv9OsF6IhYzAjQeb3gsEsLOceIhnhgJQxcoyGOI013dZ6vdc0aRuNt5O2TpB0ce4Kcd45RKm2FCV7uRxZUl2hI9DKq3sW8nHatkYwScFlnAI/mTUgzMKkbfmqNOW1xXzSYHNaOrWVBldEpEKqHSyjgiq/NXt1kiz0r3tu5ofzMcDQjdbTotFy/kMt7JOhJaMR8dWKncWyvMcnioiDKDhCQzYR+xj0dovsCqiEZ0Z9thBQoW6ZeNXKL6vg5CuasjowSyNc9qSWFvsCnl/PdchXmnr2Ct3f0JTGOZrivb+mZJkLY2sjyA9UMAYIjLIcbVtcqIhDF0oj6vcFDA65LNALQVlkKiGWvW/OdCWHi75V8CiaXBipfRoiQaHTqUgQsqdKO1/DzKnrz9cZo7LPzNWVafE7JIeEDbLqbWb2WyiadZPSETnuZNBsU3UNw/7/ePJxV0w+p48HC0HuWWYRV2v62qNg4+1UOOOjtm62uO6t/ahN4fCBsi9o3FT4bDHfDvg+RB/NJ0oEiXixVZbffHMIOrc04zJW/+4YtQhBa0W8z3P41JzdWOHs08W9ubM9g6+9011tL5eorR1k8tXSH098eB9k78BBacKULN4mPYCjZnf2lwHwsRekWxf+AVBLAwQUAAAACAAAACEAgSqKvOIBAADQBQAADQAAAHhsL3N0eWxlcy54bWy9VN9r3DAMft9fYfze+pJ1ZRtJyhgcDLYx6A366iROYvCPYCtH0r9+cpzc5WBdWaF9iaXP0icpkpXdjVqRo3BeWpPT5HpHiTCVraVpc/r7sL/6SIkHbmqurBE5nYSnd8W7zMOkxH0nBBBkMD6nHUD/mTFfdUJzf217YfCmsU5zQNW1zPdO8NoHJ61YutvdMs2loUXWWAOeVHYwkNObBSgy/0iOXGFaCWVFVlllHQGkxzxmxHAtosVXrmTpZAAbrqWaIpwGYM5osdPSWBdAFiPEb8k2sW7fMFb6urFe///Nh0cnqdSpgSmNQJH1HEA4s0eFLPJh6jG8wWGKNLPdM9at41OSftg4zAfGLa2rcXjXyAldoSJTogF0cLLtwgm2Z+ESwGoUaslba7gKlKvHIiBtJZS6DxP+0Fxwjw0xg95r+FbnFJ9KqH4VMaFFjDRRCfxbtsi9ob15ES0ZmxP/U97J896E972a9jbWF7UvSrZGi7Vkvqqks04+ommYgwoB4WjYHCCrDRLqHZunk0r/N6l/FPj+BVxs+f2bHl90+ISS8Dhy+jPsL7UhLAepQJq/dBc56/Hc2PkWeIlr8iIKctSi4YOCw+kyp2f5h6jloD+drH7Jo4XF6ix/D2MddxU77+LiD1BLAwQUAAAACAAAACEACmV1+yUBAABQAgAAEQAAAGRvY1Byb3BzL2NvcmUueG1snZLNTsMwEITvPEXke2KnAVSsJJUA9UQlJIpA3Cx721rEP7INad4eJ2nTVuqJ43pmv51duVzsVZP8gvPS6ArlGUEJaG6E1NsKva+X6RwlPjAtWGM0VKgDjxb1Tckt5cbBqzMWXJDgkwjSnnJboV0IlmLs+Q4U81l06ChujFMsxNJtsWX8m20Bzwi5xwoCEyww3ANTOxHRASn4hLQ/rhkAgmNoQIEOHudZjk/eAE75qw2DcuZUMnQWrlqP4uTeezkZ27bN2mKwxvw5/ly9vA2rplL3p+KA6lJwyh2wYFxd4vMiHq5hPqziiTcSxGMX9Stvh0XGPhBJDEDHuEflo3h6Xi9RPSOz25TkKZmv8wdKClrcffUjL/pPQHUY8m/iETDmvvwE9R9QSwMEFAAAAAgAAAAhAI0LuSekAQAAcwMAABAAAABkb2NQcm9wcy9hcHAueG1snVPLbtswELz3KwTeYypOURQGxaBwGiRAixqwk5xZamURpkiBuxbs/k2/pT/WlQwrctNeqtPs7mgw+6C6PTQ+6yChi6EQ17NcZBBsLF3YFuJpc3/1UWRIJpTGxwCFOAKKW/1OrVJsIZEDzFghYCFqonYhJdoaGoMzLgeuVDE1hjhMWxmrylm4i3bfQCA5z/MPEg4EoYTyqh0FxUlx0dH/ipbR9v7weXNsWU+rT23rnTXETeqvzqaIsaLs88GCV3JaVCy0BrtPjo46V3IaqrU1HpYsrCvjEZR8TagHMP3MVsYl1KqjRQeWYsrQ/eCpzUX23SD0dgrRmeRMIHGinYIB+xYp6ZeYdlgDECo5Jgc45U6xe69vBgKDS6IcjTC+tLhx5AG/VSuT6C+Ob6aOBw9i4vExlDyxMiZe//0+WB7dr5/JxQvLI1rFQBGzR76rpvVA/6BNRZc+2h3/8WYE52b+sL9kZRN4R3JEX1zY4VO7iXeG4Lyxy6Ra1yZByUseNzom1AO3nnzPX9YmbKE8c94W+vt6Pr0hfT2f5fwNZ3XOKfn6XPRvUEsBAgAAFAAAAAgAAAAhANXzNv1YAQAAnwUAABMAAAAAAAAAAQAAAAAAAAAAAFtDb250ZW50X1R5cGVzXS54bWxQSwECAAAUAAAACAAAACEA8p9J2ukAAABLAgAACwAAAAAAAAABAAAAAACJAQAAX3JlbHMvLnJlbHNQSwECAAAUAAAACAAAACEAFLh0yPcAAADTAwAAGgAAAAAAAAABAAAAAACbAgAAeGwvX3JlbHMvd29ya2Jvb2sueG1sLnJlbHNQSwECAAAUAAAACAAAACEARbwgcM8CAADDCgAAGAAAAAAAAAABAAAAAADKAwAAeGwvd29ya3NoZWV0cy9zaGVldDEueG1sUEsBAgAAFAAAAAgAAAAhALRpdhebAgAA8ggAABgAAAAAAAAAAQAAAAAAzwYAAHhsL3dvcmtzaGVldHMvc2hlZXQyLnhtbFBLAQIAABQAAAAIAAAAIQDW6YxxNQIAAGoGAAAYAAAAAAAAAAEAAAAAAKAJAAB4bC93b3Jrc2hlZXRzL3NoZWV0My54bWxQSwECAAAUAAAACAAAACEAP0B6EdsBAAArBAAADwAAAAAAAAABAAAAAAALDAAAeGwvd29ya2Jvb2sueG1sUEsBAgAAFAAAAAgAAAAhADxRIrb0AQAApwUAABQAAAAAAAAAAQAAAAAAEw4AAHhsL3NoYXJlZFN0cmluZ3MueG1sUEsBAgAAFAAAAAgAAAAhAD/Y7yGxBQAAUxsAABMAAAAAAAAAAQAAAAAAORAAAHhsL3RoZW1lL3RoZW1lMS54bWxQSwECAAAUAAAACAAAACEAgSqKvOIBAADQBQAADQAAAAAAAAABAAAAAAAbFgAAeGwvc3R5bGVzLnhtbFBLAQIAABQAAAAIAAAAIQAKZXX7JQEAAFACAAARAAAAAAAAAAEAAAAAACgYAABkb2NQcm9wcy9jb3JlLnhtbFBLAQIAABQAAAAIAAAAIQCNC7knpAEAAHMDAAAQAAAAAAAAAAEAAAAAAHwZAABkb2NQcm9wcy9hcHAueG1sUEsFBgAAAAAMAAwADAMAAE4bAAAAAA=="
}

Observação
1 - O "fileName" será o nome do arquivo que será feito donwload.
2 - O "file" deverá ser um arquivo convertido no formato base 64 (BLOB).

Image Added

Exemplo do retorno da API:

Integrações Clock In - api/rh/v1/DbHrEmail

API responsável por enviar um e-mail com as informações do dashboard.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

• Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

• Protheus com sua arquitetura devidamente estruturada.

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 da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para enviar as informações exibidas no Dashboard por e-mail.

Cadastro

Esta API contempla os resultados das informações exibidas no Dashboard, no caso o resultado das APIs anteriores. 

Processos

O Dashboard RH realizará o consumo da API para enviar um e-mail, contendo um HTML do Dashboard anexa.

Como realizar a chamada da API REST

• Preenchimento do EndPoint da API PONAPIDSB;
• Utilizar a chamada do método Post e do Serviço api/rh/v1/DbHrEmail;
• Preenchimento dos parâmetros obrigatórios da API;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD

Parâmetros de Entrada: