| Totvs custom tabs box items |
|---|
| default | yes |
|---|
| referencia | filiais |
|---|
| Filiais - api/rh/v1/DbHrBranches API responsável por trazer todas as filiais para serem utilizadas no filtro do Dashboard RH. Assim será possível ter uma visão macro da empresa ou apenas de uma filial em específico. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO 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. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para consultar todas as filiais cadastradas para serem utilizadas no filtro do Dashboard RH. CadastroEsta API contempla apenas a consulta das filiais cadastradas. ProcessosO Dashboard RH realizará o consumo da API para buscar todas as filiais. Como realizar a chamada da API REST- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método Get e do Serviço api/rh/v1/DbHrBranches;
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 Por ser uma API que retorna todas as filiais, não existe qualquer parâmetro que precisa ser enviado.
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/DbHrBranches Response da API: Application/json
{
"branches": [
"D MG 01 ",
"D MG 02 ",
"D RJ 01 ",
"D RJ 02 ",
"M PR 01 ",
"M PR 02 ",
"M SP 01 ",
"M SP 02 ",
"M SP 03 "
]
} 
|
| Totvs custom tabs box items |
|---|
| Ponto Completo e Incompleto - api/rh/v1/DbHrAttendanceControl API responsável por retornar o total de funcionários, funcionários com o ponto completo, incompleto e sem marcações, que não foram demitidos antes do período selecionado ou os funcionários demitidos dentro do período selecionado. Basicamente esta API irá verificar a quantidade de marcações realizadas no período pelo funcionário e irá validar com a quantidade em que o funcionário deveria realizar de acordo com o seu turno. Por exemplo um funcionário precisa realizar a marcação do ponto 4 vezes ao dia (entrada jornada, saída para o almoço, volta do almoço e saída da jornada). Na semana o funcionário trabalha de segunda à sexta, então teremos 5 dias trabalhados, onde cada dia o funcionário precisa bater o ponto 4 vezes, totalizando 20 marcações na semana. Se o funcionário possuir 20 ou mais marcações o sistema irá contabilizar como ponto completo, caso o funcionário tenha menos de 20 marcações na semana, será considerado como ponto incompleto.
Observação: O dia da demissão do funcionário contará como dia trabalhado, caso o funcionário seja demitido no dia 19/08/2022 e o filtro do período é de 01/08/2022 à 19/08/2022, a quantidade de marcações do dia 19/08/2022 será contabilizado normalmente. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO 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. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para trazer o total de funcionários, funcionários que estão com o ponto completo, incompleto e sem marcações CadastroEsta API contempla as consultas do cadastro de funcionários, turnos, tabela de horário padrão e marcações realizadas pelo funcionários. ProcessosO Dashboard RH realizará o consumo da API para buscar e exibir a quantidade total de funcionários, funcionários que estão com o ponto completo, incompleto e sem marcações 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/DbHrAttendanceControl;
- 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 As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD
Parâmetros de Entrada: | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
|---|
| startDate | 2022-11-01 | Sim | Date | Body | Data inicial do período | | endDate | 2022-11-11 | Sim | Date | Body | Data final do período | | branches | ["D MG 01"]
["D MG 01","M SP 01"]
["todas"] | Sim | Array | Body | Filtro da filial | accept | application/json | Sim | String | Header |
| content-type | application/json | Sim | String | Header |
|
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/DbHrAttendanceControl Response da API: Application/json | Bloco de código |
|---|
| {
"1": {
"branch": "Todas as Filiais",
"totalEmployees": 6,
"totalDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "GPE001- OPERACIONAL - SP "
},
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "GPE001- OPERACIONAL - SP "
},
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "GPE001- OPERACIONAL - SP "
}
],
"clockMarkingsComplete": 2,
"completeDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO ",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO ",
"department": "GPE001- OPERACIONAL - SP "
}
],
"clockMarkingsIncomplete": 2,
"incompleteDetails": [
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "DEPARTAMENTO 1 RH ",
"dateTime": "202301/03/012023",
"reason": "2 Marcaões faltantes",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "09:00 - 12:00"
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "DEPARTAMENTO 1 RH",
"dateTime": "02/03/2023",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "GPE001- OPERACIONAL - SP",
"dateTime": "01/03/2023",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "GPE001- OPERACIONAL - SP",
"dateTime": "02/03/2023",
"reason": "1 Marcação faltante",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "12:00 - 13:00 - 18:00"
}
],
"withoutClockMarkings": 2,
"withoutDetails": [
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "GPE001- OPERACIONAL - SP"
}
]
},
"2": {
"branch": "D MG 01",
"totalEmployees": 3,
"totalDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "DEPARTAMENTO 1 RH"
}
],
"clockMarkingsComplete": 1,
"completeDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "DEPARTAMENTO 1 RH"
}
],
"clockMarkingsIncomplete": 1,
"incompleteDetails": [
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "DEPARTAMENTO 1 RH",
"dateTime": "01/03/2023",
"reason": "2 Marcaões faltantes",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "09:00 - 12:00"
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "DEPARTAMENTO 1 RH",
"dateTime": "02/03/2023",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
}
],
"
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "DEPARTAMENTO 1 RH ",
"dateTime": "2023/03/02",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "GPE001- OPERACIONAL - SP ",
"dateTime": "2023/03/01",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "GPE001- OPERACIONAL - SP ",
"dateTime": "2023/03/02",
"reason": "1 Marcação faltante",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "12:00 - 13:00 - 18:00 "
}
],
"withoutClockMarkings": 2,
"withoutDetails": [
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES ",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES ",
"department": "GPE001- OPERACIONAL - SP "
}
]
},
"2": {
"branch": "D MG 01",
"totalEmployees": 3,
"totalDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO ",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "DEPARTAMENTO 1 RH "
},
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES ",
"department": "DEPARTAMENTO 1 RH "
}
],
"clockMarkingsComplete": 1,
"completeDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO ",
"department": "DEPARTAMENTO 1 RH "
}
],
"clockMarkingsIncomplete": 1,
"incompleteDetails": [
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "DEPARTAMENTO 1 RH ",
"dateTime": "2023/03/01",
"reason": "2 Marcaões faltantes",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "09:00 - 12:00 "
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "DEPARTAMENTO 1 RH ",
"dateTime": "2023/03/02",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
}
],
"withoutClockMarkings": 1,
"withoutDetails": [
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES ",
"department": "DEPARTAMENTO 1 RH "
}
]
},
"3": {
"branch": "M SP 01",
"totalEmployees": 3,
"totalDetails": [
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO ",
"department": "GPE001- OPERACIONAL - SP "
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "GPE001- OPERACIONAL - SP "
},
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES ",
"department": "GPE001- OPERACIONAL - SP "
}
],
"clockMarkingsComplete": 1,
"completeDetails": [
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO ",
"department": "GPE001- OPERACIONAL - SP "
}
],
"clockMarkingsIncomplete": 1,
"incompleteDetails": [
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "GPE001- OPERACIONAL - SP ",
"dateTime": "2023/03/01",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "GPE001- OPERACIONAL - SP ",
"dateTime": "2023/03/02",
"reason": "1 Marcação faltante",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "12:00 - 13:00 - 18:00 "withoutClockMarkings": 1,
"withoutDetails": [
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "DEPARTAMENTO 1 RH"
}
]
},
"3": {
"branch": "M SP 01",
"totalEmployees": 3,
"totalDetails": [
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "GPE001- OPERACIONAL - SP"
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "GPE001- OPERACIONAL - SP"
},
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "GPE001- OPERACIONAL - SP"
}
],
"clockMarkingsComplete": 1,
"completeDetails": [
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "GPE001- OPERACIONAL - SP"
}
],
"clockMarkingsIncomplete": 1,
"incompleteDetails": [
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO ",
"department": "GPE001- OPERACIONAL - SP",
"dateTime": "01/03/2023",
"reason": "Dia sem marcação",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": ""
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "GPE001- OPERACIONAL - SP",
"dateTime": "02/03/2023",
"reason": "1 Marcação faltante",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "12:00 - 13:00 - 18:00"
}
],
"withoutClockMarkings": 1,
"withoutDetails": [
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES ",
"department": "GPE001- OPERACIONAL - SP "
}
]
}
} |
ObservaçãoCaso 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:
Possíveis situações no envio dos filtros| Bloco de código |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"todas"
]
} |
| Bloco de código |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"D MG 01"
]
} |
| Bloco de código |
|---|
| title | Duas ou mais filiais |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"D MG 01",
"M SP 01"
]
} |
Situações de Erros TratadosO 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| Código | Erro | Detalhe |
|---|
400 | "Parâmetros inválidos: Verifique se os parâmetros startDate, endDate e filial foram enviados." |
|
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | clockin |
|---|
| 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 APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO 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. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. 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. CadastroEsta API contempla as consultas de marcações do Clock In e marcações integradas com o ERP. ProcessosO 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 As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD
Parâmetros de Entrada: | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
|---|
| startDate | 2022-05-01 | Sim | Date | Body | Data inicial do período | | endDate | 2022-05-31 | Sim | Date | Body | Data final do período | | branches | ["D MG 01"]
["D MG 01","M SP 01"]
["todas"] | Sim | Array | Body | Filtro da filial | accept | application/json | Sim | String | Header |
| content-type | application/json | Sim | String | Header |
|
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 | Bloco de código |
|---|
| {
"1": {
"branch": "Todas",
"totalClockMarkings": 7,
"totalDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 2,
"dateTime": "01/03/2023 12:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 3,
"dateTime": "01/03/2023 13:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 0,
"dateTime": "01/03/2023 18:00"
},
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
},
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 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": 3,
"integratedDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 2,
"dateTime": "01/03/2023 12:00"
},
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
}
],
"totalToBeIntegrated": 2,
"toBeIntegratedDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 3,
"dateTime": "01/03/2023 13:00"
},
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 2,
"dateTime": "01/03/2023 12:00"
}
],
"totalWhitoutNSR": 2,
"whitoutNsrDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 0,
"dateTime": "01/03/2023 18:00"
},
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 0,
"dateTime": "01/03/2023 18:00"
}
]
},
"2": {
"branch": "Filial A",
"totalClockMarkings": 4,
"totalDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 2,
"dateTime": "01/03/2023 12:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 3,
"dateTime": "01/03/2023 13:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 0,
"dateTime": "01/03/2023 18:00"
}
],
"totalIntegrated": 2,
"integratedDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
},
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 2,
"dateTime": "01/03/2023 12:00"
}
],
"totalToBeIntegrated": 1,
"clockMarkings": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 3,
"dateTime": "01/03/2023 13:00"
}
],
"totalWhitoutNSR": 1,
"whitoutNsrDetails": [
{
"CNPJ": "99999999999999",
"CPF": "44379500039",
"PIS": "61743152540",
"branch": "Filial A",
"name": "Func A",
"device": "dispositivo A",
"NSR": 0,
"dateTime": "01/03/2023 18:00"
}
]
},
"3": {
"branch": "Filial B",
"totalClockMarkings": 3,
"totalDetails": [
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
},
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 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",
"name": "Func B",
"device": "dispositivo B",
"NSR": 1,
"dateTime": "01/03/2023 09:00"
}
],
"totalToBeIntegrated": 1,
"toBeIntegratedDetails": [
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 2,
"dateTime": "01/03/2023 12:00"
}
],
"totalWhitoutNSR": 1,
"whitoutNsrDetails": [
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 0,
"dateTime": "01/03/2023 13:00"
}
]
}
} |
ObservaçãoCaso 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:
Possíveis situações no envio dos filtros| Bloco de código |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"todas"
]
} |
| Bloco de código |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"D MG 01"
]
} |
| Bloco de código |
|---|
| title | Duas ou mais filiais |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"D MG 01",
"M SP 01"
]
} |
Situações de Erros TratadosO 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| Código | Erro | Detalhe |
|---|
400 | "Parâmetros inválidos: Verifique se os parâmetros startDate, endDate e filial foram enviados." |
|
|
| Totvs custom tabs box items |
|---|
| 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 APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO 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. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para enviar as informações exibidas no Dashboard por e-mail, gerando uma imagem do Dashboard e anexando no e-mail a ser enviado. CadastroEsta API contempla os resultados das informações exibidas no Dashboard, no caso o resultado das APIs anteriores. ProcessosO Dashboard RH realizará o consumo da API para enviar um e-mail, contendo uma imagem 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 A Entrada de dado tipo string será um arquivo convertido para a base 64.
A string contendo o arquivo convertido na base 64 deverá ser enviado no body da requisição, conforme o exemplo demonstrado usando o Postman. Parâmetros de Entrada: | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
|---|
blob64 | "iVBORw0KGgoAAAANSUh..." | Sim | String | Query | Arquivo convertido para a base 64. | accept | application/json | Sim | String | Header |
| content-type | application/json | Sim | String | Header |
|
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."
}
Situações de Erros TratadosO 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| Código | Erro | Detalhe |
|---|
400 | "Falha no envio do e-mail, verifique as configurações do sistema para o envio de e-mails." |
| 401 | "A imagem do Dashboard não foi enviada." |
|
|
|
