Neste documento, será detalhado como adicionar uma frequência em nosso ambiente de trabalho utilizando a nossa API de Registro link (https://api.ro.gov.br/registros). Esta API realiza uma série de tratamentos antes de enviar o registro, onde ele será processado por outras APIs até se tornar uma frequência registrada. A API de registro é a porta de entrada para este ecossistema, verificando, por exemplo, o IP e o número de série do relógio informado, comparando-os com os registros no sistema SIF. A seguir, explicarei passo a passo como utilizar esta API.
Para que o envio do registro funcione corretamente, é necessário registrar o relógio no sistema SIF. Nele, você pode registrar um relógio padrão utilizado pelo governo ou outros modelos de relógios. Também é necessário informar quais departamentos terão permissão para registrar pontos com este relógio. Esta parte é crucial, pois as APIs do ecossistema de registro de frequência utilizam essas informações para validações. Para mais detalhes sobre como cadastrar o relógio,consulte o manual técnico.
É importante que todos os servidores que serão importados estejam devidamente cadastrados no sistema e-Estado. Alguns dos dados utilizados no ecossistema incluem departamento, matrícula, PIS, CPF e nome. Além disso, é essencial que o departamento do servidor esteja cadastrado no sistema SIF, associado ao relógio utilizado. Isso permite que o sistema valide se o servidor pertence ao departamento que está autorizado a utilizar o relógio em questão.
Para enviar um registro, é necessário utilizar o protocolo HTTP com o método POST. No corpo da requisição (body), deve ser passado o registro no formato JSON com a seguinte estrutura:
{
"localFixo": "string",
"numeroDeSerie": "string",
"ip": "string",
"registros": [
{
"pis": false,
"cpf": false,
"matricula": true,
"codigo": "300001234",
"data": "2024-05-30 07:53:13"
},
{
"pis": false,
"cpf": false,
"matricula": true,
"codigo": "300004321",
"data": "2024-05-30 07:00:20"
}
]
}
A estrutura do JSON está dividida em duas partes principais:
Exemplo:
{
"localFixo": "string",
"numeroDeSerie": "string",
"ip": "string"
}
É importante que todos os registros enviados estejam na mesma data (os horários podem variar). Não é permitido enviar registros vazios, sem código ou data.
Exemplo:
{
"registros": [
{
"pis": false,
"cpf": false,
"matricula": true,
"codigo": "300001234",
"data": "2024-05-30 07:53:13"
},
{
"pis": false,
"cpf": false,
"matricula": true,
"codigo": "300004321",
"data": "2024-05-30 07:00:20"
}
]
}
Além disso, é possível corrigir os dados enviados. Se forem identificados problemas nas frequências importadas, como um departamento não cadastrado no relógio ou um servidor sem departamento, é possível corrigir esses dados. Após a correção, basta reenviar o registro com a mesma data e o mesmo código anterior; não haverá problema em enviar o mesmo dado, pois ele não será duplicado. Como o ecossistema de frequências é cíclico, ele identificará a correção e aplicará a atualização automaticamente.
Esta documentação fornece as informações necessárias para utilizar a API de registro corretamente. Certifique-se de seguir todos os passos e validar as informações antes de enviar os registros para garantir o bom funcionamento do sistema.
Além disso, o sistema Guardião da Frequência facilita a identificação de problemas nas frequências importadas. Ele permite que caso tenha corrigido o problema do servidor poderá fazer o reenvio dos registros via interface, simplificando o processo de atualização e garantindo que os dados estejam sempre corretos.
Caso precise de mais informações ou tenha dúvidas, entre em contato conosco.