API - Módulos
- Home
- Colaborador
- Estr. Orga
- Frequência
- Config.
- Relatórios
- Restaurante
- Auto Atendimento
Apresentamos o Documento de Especificações Técnicas da solução NewPonto API desenvolvida pela Norber Tecnologia, documento este que possui a finalidade de fornecer informações detalhadas sobre a NewPonto API, definidas a partir de levantamento realizado por nossa equipe técnica durante a fase de análise e desenvolvimento.
Este documento estabelece as configurações básicas para formatação de arquivos Json para a utilização correta dos métodos disponibilizados.
O NewPonto API foi desenvolvido com a tecnologia REST para todos os métodos, que é padrão de mercado e independe da tecnologia utilizada por nossos clientes. Dessa forma, é possível integrar-se utilizando as mais variadas linguagens de programação, tais como:
Entre outras características, os atributos que mais se destacam na plataforma:
A integração será realizada por meio de serviços disponibilizados como Web Services. O modelo será empregado através de uma URL (endpoint), o NewPonto API recebe as mensagens HTTP através dos métodos POST, GET, ou, PUT.
POST: O método HTTP POST é utilizado na criação dos recursos ou no envio de informações que serão processadas. Por exemplo, criação de uma escala de trabalho.
PUT: O método HTTP PUT é utilizado para atualização de recursos já existente. Por exemplo, alterar os dados cadastrais de um colaborador.
GET: O método HTTP GET é utilizado para consultas de recursos já existentes. Por exemplo carregar a lista de feriados por colaborador.
O SWAGGER UI é um API Client, que facilita aos desenvolvedores criar, compartilhar, testar e documentar APIS. Isso é feito, permitindo aos usuários criar e salvar solicitações HTTP e HTTPS simples e complexas, bem como ler suas respostas. Use-o para testar e se ambientar com a nossa API, antes, de iniciar o desenvolvimento da integração de fato.
Observação: Todos os procedimentos aqui especificados foram detalhados para serem usados através da ferramenta Swagger UI, porém, o acesso aos métodos poderá ser efetuado tanto por meio da ferramenta aqui citada ou diretamente por outros frameworks, como SoapUI, Postman, etc..
Por segurança a URL com o ambiente de produção/homologação e usuário de acesso é encaminhado ao cliente por intermédio do analista de implantação responsável.
Mas a composição da URL é realizada da seguinte maneira:
HTTPS://ENDERECO-DO-SERVIDOR/NOME-DA-APLICACAO/API
Sendo o PROTOCOLO HTTPS, o ENDEREÇO DO SERVIDOR, O NOME DA APLICAÇÃO, O SUFIXO “API” SEGUIDO PELO NOME DO MÉTODO.
Exemplo
- Método /api/autenticacao/autenticar
https://endereco-produto.com.br/NorberApi/api/autenticacao/autenticar
- Método /api/banco-de-horas/listar-saldo
https://endereco-produto.com.br/NorberApi/api/banco-de-horas/listar-saldo
Observação: Verificar o “endereco-produto” com o analista de implantação responsável.
A fim de manter a performance do sistema, se fez necessário implementar o conceito de paginação para alguns dos métodos desenvolvidos e exemplificados desde documento, desta forma, cada requisição realizada irá retornar o total de 20 contratos com os saldos apurados.
Observação: A quantidade de contratos será definido através da TAG
Caso o usuário do NewPonto API realize uma requisição que possua mais de 20 contratos, o usuário deverá realizar mais de uma requisição informando a mesma lista de conceitos alterando apenas a numeração da página que será processada.
Caso o usuário faça a alteração dos conceitos listados na requisição, seja incluindo ou retirando conceitos da lista, contratos poderão ser apurados mais de uma vez enquanto outros contratos poderão deixar de serem apurados.
A quantidade total de páginas será o resultado da quantidade de contratos enviado na requisição dividido por 20 (Contratos / 20). Caso a quantidade total de contratos seja igual ou inferior a 20, deverá assumir automaticamente o valor de 1.
A paginação será iniciada a partir do índice 1 (um), tanto para o parâmetro “página” da requisição quanto para o retorno da requisição nos parâmetros “página” e “quantidade total de páginas”;
Alguns dos métodos exemplificados neste documento poderão receber 1 ou vários conceitos por requisição, sendo necessário informar o enumerador de cada conceito e os respectivos códigos dos registros. Sendo eles:
Os métodos poderão receber uma lista de registros do mesmo conceito, ou uma lista de registros de conceitos diferentes.
Ao receber uma lista de registros do mesmo conceito, o método irá filtrar os contratos utilizando o operador lógico “OR” (ou).
Exemplo
Requisição:
- Mês e ano de referência: 2020-01
- Conceito: 1
- Código Externo: 1
- Conceito: 1
- Código Externo: 2
- Página: 1
Resposta:
- O método trará como resposta todas as mátriculas que associadas na empresa de código 1 e também as matriculas associadas a empresa de código 2.
Ao receber uma lista de registros de conceitos diferentes, o método irá filtrar os contratos utilizando o operador lógico “AND” (e).
Exemplo
Requisição:
- Mês e ano de referência: 2020-01
- Conceito: 1
- Código Externo: 1
- Conceito: 2
- Código Externo: 1
- Página: 1
Resposta:
- O método trará como resposta todas as mátriculas que associadas na empresa de código 1 e que estão associadas na unidade organizacional de código 1.
Ao receber uma lista de registros de conceitos diferentes, para compor este filtro de contratos através do conceito informado, o método deverá seguir a ordem hierárquica, agrupando os conceitos na seguinte ordem:
Autenticação: Processo para garantir quem está tentando acessar a API é de fato quem diz ser.
Autorização: Após autenticado o processo de autorização garante que o usuário possa acessar e ver somente o que foi definido para ele.
Para realizar a chamada de qualquer método da solução NewPonto API, é necessário utilizar o método /api/autenticacao/autenticar. Se trata de um método GET com tecnologia REST que retornará um token de acesso de acordo com o usuário e senha informados no Json da requisição.
O Token terá validade de tempo equiparada uma sessão de um usuário autenticado nas demais soluções de Folha e Frequência. Ao término dessa validade, será obrigatório realizar uma nova requisição e utilizar este novo token nos demais métodos.
Caso a validade não tenha se esgotado, o token poderá ser utilizado por várias requisições futuras.
1 - Requisição - /api/autenticacao/autenticar
Abaixo um exemplo de Json que deverá ser enviado na requisição do método, o Json exemplificado está utilizando o conceito de matrícula e enviando apenas 1 contrato.
Observação: Usuário utilizado é meramente ilustrativo, deverá consultar o analista de implantação responsável para obter o login de acesso.
Para a utilização do método /api/autenticacao/autenticar, o parâmetro TOKEN poderá ser preenchido com qualquer valor alfanuméricor.
Método: GET
Path: /api/autenticacao/autenticar
Header: { token: ”qualquer valor alfanuméricor” }
2 - Retorno - /api/autenticacao/autenticar
O Token é retornado no parâmetro ObjetoDeRetorno, no exemplo abaixo é apresentado como bc2f204f-e203-492e-9bf8-db459ec40fc2. Para as futuras requisições nos demais métodos, deverá ser informado este código no parâmetro TOKEN de cada método.
Caso as credenciais não sejam fornecidas corretamente e a autenticação não seja concluída, através do response Body do método, será possível obter o parâmetro “message” que disponibilizará o erro encontrado durante a autenticação.
Segue abaixo exemplo de Response Body negativo:
Através da NewPonto API estará disponível a consulta de Saldo de Banco de horas de colaboradores já cadastrados no sistema.
Para o método “/api/banco-de-horas/listar-saldo”, é adotado o conceito de paginação. Para mais informações, verificar a sessão 6 Paginação dos métodos.
A requisição poderá ser realizada através de 3 conceitos distintos, sendo eles “Empresa”, “Unidade Organizacional” e “Matrícula. Cada conceito terá seu próprio enumerador para ser informado na requisição do método. Para mais informações, verificar a sessão 7 Filtro de Conceitos.
A API poderá receber 1 conceito ou uma lista de conceitos por requisição realizada.
Ao retornar o “saldo de banco de horas” apurado do período deverá conter as matriculas apuradas, mês de referência, o saldo de banco do período, a pagina processada na requisição e a quantidade total de páginas.
Para realizar a apuração do saldo de banco de horas dos contratos, o NewPonto API utiliza os mesmos cálculos realizados hoje através da funcionalidade “Consolidação Folha”.
1 - Requisição /api/banco-de-horas/listar-saldo
Ao realizar a requisição do método “listar-saldo”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: api/banco-de-horas/listar-saldo
Header: { token: ”INFORME-O-TOKEN-AQUI” }
2 - Resposta api/banco-de-horas/listar-saldo
A resposta da requisição do método “listar-saldo” conterá os seguintes dados:
Através da NewPonto API estará disponível o cadastro, manutenção e pesquisa do conceito de Cargo, que posteriormente serão associados ao contrato de novos colaboradores no sistema. Os métodos para cadastro, manutenção e pesquisa de Cargo disponíveis serão:
Os métodos Incluir, Alterar e Excluir irão trabalhar com apenas 1 registro por requisição realizada, estes métodos não trabalharão com o conceito de lista.
Observação: Estes métodos não estarão disponível caso o cliente utilize as soluções Norber Tecnologia integradas com as soluções LG Sistemas. Caso o cliente necessite utilizar teste método, deverá entrar em contato com o Analista de Implantação responsável que passará as orientações necessárias.
1 - Requisição – Incluir - /api/v2/cargo/incluirCargo
O método “incluirCargo” permitirá inserir registros para a funcionalidade Cargo sem a necessidade de utilizar a ferramenta NewPonto Cloud.
Ao realizar a requisição do método “incluirCargo”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método:
Path: /api/v2/cargo/incluirCargo
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
2 - Resposta – Incluir - /api/v2/cargo/incluirCargo
A resposta da requisição do método “incluirCargo” conterá dados sobre data da requisição, data da resposta, o tipo de requisição e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
3 - Requisição – Alterar - /api/v2/cargo/alterarCargo
O método “alterarCargo” permitirá alterar registros já existentes para a funcionalidade Cargo sem a necessidade de utilizar a ferramenta NewPonto Cloud.
Ao realizar a requisição do método “alterarCargo”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Ao utilizar o método “alterarCargo” é necessário preencher todos os parâmetros, mesmo para os campos dos quais não deseja fazer alteração.
Método: POST
Path: /api/v2/cargo/alterarCargo
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
4 - Resposta – Alterar - /api/v2/cargo/alterarCargo
A resposta da requisição do método “alterarCargo” conterá dados sobre data da requisição, data da resposta, o tipo de requisição e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a alteração do registro
5 - Requisição – Excluir - /api/v2/cargo/excluirCargo
O método “excluirCargo” permitirá excluir todo e qualquer registro de cargo realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluirCargo”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/v2/cargo/excluirCargo
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
6 - Resposta – Excluir - /api/v2/cargo/excluirCargo
A resposta da requisição do método “excluirCargo” conterá dados sobre data ad requisição, data da resposta, o Tipo Da Requisição realizada e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
7 - Requisição – Consultar - /api/v2/cargo/consultarCargo
O método “consultarCargo” permitirá consultar todo e qualquer registro de cargo realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “consultarCargo”, deverá se atentar as informações de preenchimento que permitirão realizar as buscas pelos cargos, sendo elas:
Observação: Para este método, não é necessário todos os parâmetros, apenas aquele que deseja utilizar no momento da consultar, mantendo os demais parâmetros em branco.
Método: GET
Path: /api/v2/cargo/consultarCargo
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
8 - Resposta – Consultar - /api/v2/cargo/consultarCargo
A resposta da requisição do método “consultarCargo” conterá dados sobre data ad requisição, data da resposta, o Tipo Da Requisição realizada e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a consulta do registro
Através da NewPonto API estará disponível o cadastro, manutenção e pesquisa do conceito de Centro de Custo, que posteriormente serão associados ao contrato de novos colaboradores no sistema. Os métodos para cadastro, manutenção e pesquisa de Centro De Custo disponíveis serão:
Os métodos Incluir, Alterar e Excluir irão trabalhar com apenas 1 registro por requisição realizada, estes métodos não trabalharão com o conceito de lista.
Observação: Estes métodos não estarão disponível caso o cliente utilize as soluções Norber Tecnologia integradas com as soluções LG Sistemas. Caso o cliente necessite utilizar teste método, deverá entrar em contato com o Analista de Implantação responsável que passará as orientações necessárias.
1 - Requisição – Incluir -/api/v2/centrodecusto/incluirCentroDeCusto
O método “incluirCentroDeCusto” permitirá inserir registros para a funcionalidade Centro de Custo sem a necessidade de utilizar a ferramenta NewPonto Cloud.
Ao realizar a requisição do método “incluirCentroDeCusto”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/v2/centrodecusto/incluirCentroDeCusto
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
2 - Resposta – Incluir - /api/v2/centrodecusto/incluirCentroDeCusto
A resposta da requisição do método “incluirCentroDeCusto” conterá dados sobre data da requisição, data da resposta, o tipo de requisição e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
3 - Requisição – Alterar - /api/v2/centrodecusto/alterarCentroDeCusto
O método “alterarCentroDeCusto” permitirá alterar registros já existentes para a funcionalidade Centro de Custo sem a necessidade de utilizar a ferramenta NewPonto Cloud.
Ao realizar a requisição do método “alterarCentroDeCusto”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Ao utilizar o método “alterarCentroDeCusto” é necessário preencher todos os parâmetros, mesmo para os campos dos quais não deseja fazer alteração.
Método: POST
Path: /api/v2/centrodecusto/alterarCentroDeCusto
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
4 - Resposta – Alterar - /api/v2/centrodecusto/alterarCentroDeCusto
A resposta da requisição do método “alterarCentroDeCusto” conterá dados sobre data da requisição, data da resposta, o tipo de requisição e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a alteração do registro
5 - Requisição – Excluir - /api/v2/centrodecusto/excluirCentroDeCusto
O método “excluirCentroDeCusto” permitirá excluir todo e qualquer registro de centro de custo realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluirCentroDeCusto”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/v2/centrodecusto/excluirCentroDeCusto
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
6 - Resposta – Excluir - /api/v2/centrodecusto/excluirCentroDeCusto
A resposta da requisição do método “excluirCentroDeCusto” conterá dados sobre data da requisição, data da resposta, o Tipo Da Requisição realizada e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
7 - Requisição – Consultar - /api/v2/centrodecusto/consultarCentroDeCusto
O método “consultarCentroDeCusto” permitirá consultar todo e qualquer registro de centro de custo realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “consultarCentroDeCusto”, deverá se atentar as informações de preenchimento que permitirão realizar as buscas pelos centros de custo, sendo elas:
Observação: Para este método, não é necessário todos os parâmetros, apenas aquele que deseja utilizar no momento da consultar, mantendo os demais parâmetros em branco.
Método: GET
Path: /api/v2/centrodecusto/consultarCentroDeCusto
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
8 - Resposta – Consultar - /api/v2/centrodecusto/consultarCentroDeCusto
A resposta da requisição do método “consultarCentroDeCusto” conterá dados sobre data ad requisição, data da resposta, o Tipo Da Requisição realizada e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a consulta do registro
Através da NewPonto API, estará disponível a admissão de novos colaboradores no sistema. Será possível através dos métodos:
Através destes métodos serão incluídos durante a requisição informações competentes ao cadastro de pessoa, como: Nome, Data de Nascimento, CPF etc., e informações competentes ao cadastro de contratos, como Matrícula do contrato, empresa, escala etc.
Observação: Estes métodos não estarão disponível caso o cliente utilize as soluções Norber Tecnologia integradas com as soluções LG Sistemas. Caso o cliente necessite utilizar teste método, deverá entrar em contato com o Analista de Implantação responsável que passará as orientações necessárias.
1 - Requisição – Incluir - /api/colaborador/incluir-colaborador
As informações apresentadas aqui para o método “incluir-colaborador” também poderá ser aplicada para o método “incluir-lista-colaborador”
Ao realizar a requisição do método “Incluir Colaborador”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/colaborador/incluir-colaborador
Header: { token: ”INFORME-O-TOKEN-AQUI” }
2 - Resposta – Incluir - /api/colaborador/incluir-colaborador
A resposta da requisição do método “incluir-colaborador” conterá os dados completos dos conceitos de cadastro de Pessoa e cadastro de Contrato.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
3 - Requisição – Incluir - /api/colaborador/incluir-lista-colaboradores
O método “incluir-lista-colaborador” possui as mesmas características e parâmetros que o método “incluir-colaborador”, porém o método “incluir-lista-colaborador” permite enviar mais de um contrato por requisição.
Observação: Para saber mais sobre os parâmetros deste método, verificar o item 12.1 Requisição – Incluir - /api/colaborador/incluir-colaborador
Abaixo um exemplo de como o Json deve ser organizado para teste método especifico.
Método: POST
Path: /api/colaborador/incluir-lista-colaborador
Header: { token: ”INFORME-O-TOKEN-AQUI” }
4 - Resposta – Incluir - /api/colaborador/incluir-lista-colaboradores
A resposta da requisição do método “incluir-lista-colaborador” conterá os dados completos dos conceitos de cadastro de Pessoa e cadastro de Contrato.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
Através da NewPonto API estará disponível o cadastro, manutenção e pesquisa do conceito de Unidade Organizacional (também conhecido como Departamento), que posteriormente serão associados ao contrato de novos colaboradores no sistema. Os métodos para cadastro, manutenção e pesquisa de Unidade Organizacional disponíveis serão:
Os métodos Incluir, Alterar e Excluir irão trabalhar com apenas 1 registro por requisição realizada, estes métodos não trabalharão com o conceito de lista.
Observação: Estes métodos não estarão disponível caso o cliente utilize as soluções Norber Tecnologia integradas com as soluções LG Sistemas. Caso o cliente necessite utilizar teste método, deverá entrar em contato com o Analista de Implantação responsável que passará as orientações necessárias.
1 - Requisição – Incluir - /api/v2/departamento/incluirDepartamento
O método “incluirDepartamento” permitirá inserir registros para a funcionalidade Unidade Organizacional sem a necessidade de utilizar a ferramenta NewPonto Cloud.
Ao realizar a requisição do método “incluirDepartamento”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/v2/departamento/incluirDepartamento
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
2 - Resposta – Incluir - /api/v2/departamento/incluirDepartamento
A resposta da requisição do método “incluirDepartamento” conterá dados sobre data da requisição, data da resposta, o tipo de requisição e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
3 - Requisição – Alterar - /api/v2/departamento/alterar departamento
O método “alterarDepartamento” permitirá alterar registros já existentes para a funcionalidade Unidade Organizacional sem a necessidade de utilizar a ferramenta NewPonto Cloud.
Ao realizar a requisição do método “alterarDepartamento”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Ao utilizar o método “alterarDepartamento” é necessário preencher todos os parâmetros, mesmo para os campos dos quais não deseja fazer alteração.
Método: POST
Path: /api/v2/departamento/alterarDepartamento
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
4 - Resposta – Alterar - /api/v2/departamento/alterarDepartamento
A resposta da requisição do método “alterarDepartamento” conterá dados sobre data da requisição, data da resposta, o tipo de requisição e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a alteração do registro
5 - Requisição – Exclusão - /api/v2/departamento/excluir departamento
O método “excluirDepartamento” permitirá excluir todo e qualquer registro de Unidade Organizacional cadastrado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluirDepartamento”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/v2/departamento/excluirDepartamento
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
6 - Resposta – Excluir - /api/v2/departamento/excluirDepartamento
A resposta da requisição do método “excluirDepartamento” conterá dados sobre data da requisição, data da resposta, o Tipo Da Requisição realizada e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
7 - Requisição – Consultar - /api/v2/departamento/consultar departamento
O método “consultarDepartamento” permitirá consultar todo e qualquer registro de Unidade Organizacional realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “consultarDepartamento”, deverá se atentar as informações de preenchimento que permitirão realizar as buscas pelas unidades organizacionais, sendo elas:
Observação: Para este método, não é necessário todos os parâmetros, apenas aquele que deseja utilizar no momento da consultar, mantendo os demais parâmetros em branco.
Método: GET
Path: /api/v2/departamento/consultarDepartamento
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
8 - Resposta – Consultar - /api/v2/departamento/consultar departamento
A resposta da requisição do método “consultarDepartamento” conterá dados sobre data da requisição, data da resposta, o Tipo Da Requisição realizada e os dados do objeto.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a consulta do registro
Através da NewPonto API estará disponível a consulta das horas reais trabalhadas e de horas extras detalhadas de colaboradores já cadastrados no sistema.
Para o método “listar-he-horastrabalhadas”, é adotado o conceito de paginação. Para mais informações, verificar a sessão 6 Paginação dos métodos.
A requisição poderá ser realizada através de 3 conceitos distintos, sendo eles “Empresa”, “Unidade Organizacional” e “Matrícula. Cada conceito terá seu próprio enumerador para ser informado na requisição do método. Para mais informações, verificar a sessão 7 Filtro de Conceitos.
A API poderá receber 1 conceito ou uma lista de conceitos por requisição realizada.
1 - Requisição - /api/eventos/listar-he-horastrabalhadas
O método estará disponível em /api/eventos/listar-he-horastrabalhadas e do tipo GET. Abaixo um exemplo de Json que deverá ser enviado na requisição do método, o Json exemplificado está utilizando o conceito de matrícula e enviando apenas 1 contrato.
Ao realizar a requisição do método “listar-he-horastrabalhadas”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Caso não seja informado pelo usuário, irá assumir o valor 1 (um) para o número atual da página;
Para o parâmetro Token, deverá passar o código retornado no parâmetro ObjetoDeRetorno do método /api/autenticacao/autenticar.
Método: GET
>Path: /api/eventos/listar-he-horastrabalhadas
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
2 - Resposta - /api/eventos/listar-he-horastrabalhadas
A resposta da requisição do método “listar-he-horastrabalhadas” conterá os seguintes dados:
No exemplo listado abaixo de retorno do método.
Através da NewPonto API estará disponível a movimentação de Ocorrências Folha de colaboradores já cadastrados no sistema. As ocorrências disponíveis para a movimentação das “ocorrências folha” serão:
A API poderá receber a movimentação de 1 colaborador ou uma lista de colaboradores movimentados por requisição realizada em cada um dos métodos de inclusão.
Observação: Estes métodos não estarão disponível caso o cliente utilize as soluções Norber Tecnologia integradas com as soluções LG Sistemas. Caso o cliente necessite utilizar teste método, deverá entrar em contato com o Analista de Implantação responsável que passará as orientações necessárias.
1 - Afastamento – Requisição – Incluir - /api/ocorrencias-folha/incluir-afastamento
As informações apresentadas para o método “Incluir-afastamento” poderá ser aplicado para o método “Incluir-lista-afastamentos”.
Ao realizar a requisição do método “Incluir-afastamento” ou “Incluir-lista-afastamentos”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/ocorrencias-folha/incluir-afastamento
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
2 - Afastamento - Resposta – Inclusão - /api/ocorrencias-folha/incluir-afastamento
A resposta da requisição do método “incluir-afastamento” conterá os dados completos dos conceitos de Pessoa, Contrato e Afastamento.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
3 - Afastamento – Requisição – Incluir - /api/ocorrencias-folha/incluir-lista-afastamentos
O método “incluir-lista-afastamentos” possui as mesmas características e parâmetros que o método “incluir-afastamento”, porém o método “incluir-lista-afastamentos” permite enviar mais de um contrato por requisição.
Observação: Para saber mais sobre os parâmetros deste método, verificar o item 15.1 Afastamento – Requisição – Incluir - /api/ocorrencias-folha/incluir-afastamento
Abaixo um exemplo de como o Json deve ser organizado para teste método específico.
Método: POST
Path: /api/colaborador/incluir-lista-afastamentos
Header: { token: ”INFORME-O-TOKEN-AQUI” }
4 - Afastamento – Resposta – Incluir - /api/ocorrencias-folha/incluir-lista-afastamentos
A resposta da requisição do método “incluir-lista-afastamentos” conterá os dados completos dos conceitos de Pessoa, Contrato e Afastamento.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
5 - Férias – Requisição – Incluir - /api/ocorrencias-folha/incluir-férias
As informações apresentadas para o método “Incluir-ferias” poderá ser aplicado para o método “Incluir-lista-ferias”.
Ao realizar a requisição do método “Incluir-ferias” ou “Incluir-lista-ferias”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/ocorrencias-folha/incluir-ferias
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
6 - Férias – Resposta – Incluir - /api/ocorrencias-folha/incluir-férias
A resposta da requisição do método “incluir-ferias” conterá os dados completos dos conceitos de Pessoa, Contrato e Férias.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
7 - Férias – Requisição – Incluir - /api/ocorrencias-folha/incluir-lista-férias
O método “incluir-lista-ferias” possui as mesmas características e parâmetros que o método “incluir-ferias”, porém o método “incluir-lista-ferias” permite enviar mais de um contrato por requisição.
Observação: Para saber mais sobre os parâmetros deste método, verificar o item 15.5 Férias – Requisição – Incluir - /api/ocorrencias-folha/incluir-férias
Abaixo um exemplo de como o Json deve ser organizado para teste método específico.
Método: POST
Path: /api/colaborador/incluir-lista-ferias
Header: { token: ”INFORME-O-TOKEN-AQUI” }
8 - Férias – Resposta – Incluir - /api/ocorrencias-folha/incluir-lista-férias
A resposta da requisição do método “incluir-lista-ferias” conterá os dados completos dos conceitos de Pessoa, Contrato e Férias.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
9 - Recesso – Requisição – Incluir - /api/ocorrencias-folha/incluir-recesso
As informações apresentadas para o método “Incluir-recesso” poderá ser aplicado para o método “Incluir-lista-recessos”.
Ao realizar a requisição do método “Incluir- recesso” ou “Incluir-lista-recessos”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/ocorrencias-folha/incluir-recesso
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
10 - Recesso – Resposta – Incluir - /api/ocorrencias-folha/incluir- recesso
A resposta da requisição do método “incluir-recesso” conterá os dados completos dos conceitos de Pessoa, Contrato e Recesso.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
11 - Recesso – Requisição – Incluir - /api/ocorrencias-folha/incluir-lista-recessos
O método “incluir-lista-recessos” possui as mesmas características e parâmetros que o método “incluir-recesso”, porém o método “incluir-lista-recessos” permite enviar mais de um contrato por requisição.
Observação: Para saber mais sobre os parâmetros deste método, verificar o item 15.9 Recesso – Requisição – Incluir - /api/ocorrencias-folha/incluir-recesso
Abaixo um exemplo de como o Json deve ser organizado para teste método específico.
Método: POST
Path: /api/colaborador/incluir-lista-recessos
Header: { token: ”INFORME-O-TOKEN-AQUI” }
12 - Recesso – Resposta – Incluir - /api/ocorrencias-folha/incluir-lista-recessos
A resposta da requisição do método “incluir-lista-recessos” conterá os dados completos dos conceitos de Pessoa, Contrato e Recesso.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
13 - Rescisão – Requisição – Incluir - /api/ocorrencias-folha/incluir-rescisao
As informações apresentadas para o método “Incluir-rescisão” poderá ser aplicado para o método “Incluir-lista-rescisões”.
Ao realizar a requisição do método “Incluir- recesso” ou “Incluir-lista-rescisão”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Método: POST
Path: /api/ocorrencias-folha/incluir-rescisão
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
14 - Rescisão – Resposta – Incluir - /api/ocorrencias-folha/incluir- rescisao
A resposta da requisição do método “incluir-rescisão” conterá os dados completos dos conceitos de Pessoa, Contrato e Recesso.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
15 - Rescisão – Requisição – Incluir - /api/ocorrencias-folha/incluir-lista-rescisoes
O método “incluir-lista-rescisão” possui as mesmas características e parâmetros que o método “incluir-rescisao”, porém o método “incluir-lista-rescisoes” permite enviar mais de um contrato por requisição.
Observação: Para saber mais sobre os parâmetros deste método, verificar o item 15.13 Rescisão – Requisição – Incluir - /api/ocorrencias-folha/incluir-rescisao
Abaixo um exemplo de como o Json deve ser organizado para teste método específico.
Método: POST
Path: /api/colaborador/incluir-lista-rescisoes
Header: { token: ”INFORME-O-TOKEN-AQUI” }
16 - Rescisão – Resposta – Incluir - /api/ocorrencias-folha/incluir-lista-rescisoes
A resposta da requisição do método “incluir-lista-rescisoes” conterá os dados completos dos conceitos de Pessoa, Contrato e Rescisão.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a inclusão do registro
17 - Afastamento – Requisição – Excluir - /api/ocorrencias-folha/excluir-afastamento
As informações apresentadas para o método “excluir-afastamento” poderá ser aplicado para os demais métodos de “excluir” em ocorrências folha.
O método “excluir-afastamento” permitirá excluir todo e qualquer lançamento de afastamento realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluir-afastamento”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/ocorrencias-folha/excluir-afastamento
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
18 - Afastamento – Resposta – Excluir - /api/ocorrencias-folha/excluir-afastamento
A resposta da requisição do método “excluir-afastamento” conterá dados sobre data ad requisição, data da resposta e o Tipo Da Requisição realizada.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
19 - Férias – Requisição – Excluir - /api/ocorrencias-folha/excluir-férias
As informações apresentadas para o método “excluir-ferias” poderá ser aplicado para os demais métodos de “excluir” em ocorrências folha.
O método “excluir-ferias” permitirá excluir todo e qualquer lançamento de ferias realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluir-ferias”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/ocorrencias-folha/excluir-ferias
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
20 - Férias – Resposta – Excluir - /api/ocorrencias-folha/excluir-férias
A resposta da requisição do método “excluir-ferias” conterá dados sobre data ad requisição, data da resposta e o Tipo Da Requisição realizada.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
21 - Recesso – Requisição – Excluir – /api/ocorrencias-folha/excluir-recesso
As informações apresentadas para o método “excluir-recesso” poderá ser aplicado para os demais métodos de “excluir” em ocorrências folha.
O método “excluir-recesso” permitirá excluir todo e qualquer lançamento de recesso realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluir-recesso”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/ocorrencias-folha/excluir-recesso
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
22 - Férias – Resposta – Excluir - /api/ocorrencias-folha/excluir-recesso
A resposta da requisição do método “excluir-recesso” conterá dados sobre data ad requisição, data da resposta e o Tipo Da Requisição realizada.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
23 - Rescisão – Requisição – Excluir – /api/ocorrencias-folha/excluir-rescisao
As informações apresentadas para o método “excluir-rescisao” poderá ser aplicado para os demais métodos de “excluir” em ocorrências folha.
O método “excluir-rescisao” permitirá excluir todo e qualquer lançamento de rescisão realizado, seja por meio do NewPonto Cloud ou por meio do NewPonto API.
Ao realizar a requisição do método “excluir-rescisao”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Para este método, não é necessário montar um json, basta informar os parâmetros na Curl do método.
Método: POST
Path: /api/ocorrencias-folha/excluir-recesso
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
24 - Rescisão – Resposta – Excluir - /api/ocorrencias-folha/excluir-recesso
A resposta da requisição do método “excluir- rescisao” conterá dados sobre data ad requisição, data da resposta e o Tipo Da Requisição realizada.
No parâmetro “Inconsistências” será descrito todos os problemas encontrados durante a execução do método, caso não ocorram erros, o parâmetro retornará vazio.
Abaixo um exemplo de retorno positivo onde o método realizou a exclusão do registro
Abaixo os códigos que serão consumidos durante o processamento para o campo 057 – Movimentação CAGED.
| Código Movimentação CAGED | Descrição Movimentação CAGED |
| 0 | Não definido |
| 10 | Admissão empregado primeiro emprego |
| 20 | Admissão empregado emprego anterior |
| 25 | Contrato prazo determinado |
| 31 | Dispensa sem justa causa |
| 32 | Dispensa por justa causa |
| 35 | Reintegração |
| 40 | Desligamento iniciativa própria |
| 43 | Termino contrato prazo determinado |
| 45 | Termino contato |
| 50 | Desligamento aposentadoria |
| 60 | Desligamento Morte |
| 70 | Transferência entrada |
| 80 | Transferência saída |
| 90 | Desligamento por acordo empregado empregador |
Através da NewPonto API estará disponível a consulta das horas extras diárias dos colaboradores já cadastrados no sistema.
Para o método “RetornaHoraExtraDiaria”, é adotado o conceito de paginação. Para mais informações, verificar a sessão 6 Paginação dos métodos.
A requisição poderá ser realizada através de 3 conceitos distintos, sendo eles “Empresa”, “Unidade Organizacional” e “Matrícula. Cada conceito terá seu próprio enumerador para ser informado na requisição do método. Para mais informações, verificar a sessão 7 Filtro de Conceitos.
A API poderá receber 1 conceito ou uma lista de conceitos por requisição realizada.
1 - Requisição - /api/ocorrencias/RetornaHoraExtraDiaria
O método estará disponível em /api/ocorrencias/RetornaHoraExtraDiaria e do tipo GET. Abaixo um exemplo de Json que deverá ser enviado na requisição do método, o Json exemplificado está utilizando o conceito de matrícula e enviando apenas 1 contrato.
Ao realizar a requisição do método “RetornaHoraExtraDiaria”, deverá se atentar as informações de preenchimento obrigatório, sendo elas:
Observação: Caso não seja informado pelo usuário, irá assumir o valor 1 (um) para o número atual da página;
Para o parâmetro Token, deverá passar o código retornado no parâmetro ObjetoDeRetorno do método /api/autenticacao/autenticar.
Método: GET
Path: /api/ocorrencias/RetornaHoraExtraDiaria
Header: { token: ”INFORME-O-TOKEN-RETORNADO-DO-MÉTODO- AUTENTICAR-AQUI” }
2 - Resposta - /api/ocorrencias/RetornarHoraExtraDiaria
A resposta da requisição do método “RetornaHoraExtraDiaria” conterá os seguintes dados:
No exemplo listado abaixo de retorno do método.
