Serviço externo padrão MentorWeb - Serviço de registro de entrada e saída
Nome do serviço externo: registroEntradaSaidaPadrao
Disponibilizado um serviço para ser instalado no servidor da catraca.
Este serviço recebe como parâmetros o código do usuário, o tipo de acesso e a data e hora do acesso realizado. Com base no código do usuário, verifica nas configurações gerais do controle de frequência o formato do campo de identificação da pessoa. Em seguida, identifica a pessoa associada ao registro de acesso e verifica se é necessário enviar uma notificação de acesso.
1. Parâmetros para chamada do serviço externo
| Parâmetro | Descrição | Obrigatório | Tipo | Observação |
|---|---|---|---|---|
| codigoUsuario | Código do usuário | Sim | Alfanumérico | Sem máscara |
| tipoAcesso | Tipo do acesso | Sim | Alfanumérico | Valores: entrada / saida |
| dataHora | Data e hora do acesso | Sim | Data e hora | DD/MM/YYYY HH:MM |
| turno | Turno do horário | Não | Alfanumérico | M=Matutino V=Vespertino N=Noturno |
Após identificar a pessoa, o serviço registra o acesso no controle de acessos (tb_entrada_saida), levando em consideração o tipo de acesso solicitado e a data/hora do evento. Adicionalmente, verifica nas configurações gerais se o envio de notificações está configurado. Se estiver marcado, envia uma notificação push para o responsável pedagógico do aluno, utilizando o texto fornecido no novo campo.
O serviço então deve retornar:
| Campo | Informação | Tipo | Observação |
|---|---|---|---|
| Retorno | Descrição do retorno | String(120) | Retorno do processo:Registro de entrada/saída realizado com sucesso; Não identificada matrícula ativa; Não identificada pessoa |
| Resultado | Retorna o resultado do processo | String (7) | Valores possíveis: SUCESSO / ERRO |
O retorno deverá trazer o motivo pelo qual não foi possível registrar a entrada/saída, ou a confirmação do registro. O serviço deve ser padrão e trabalhar com os métodos disponíveis pelo sistema, assim como a tokenização.
Instruções para realizar a chamada
- Para realizar as chamadas dos endpoints via API, segue as configurações necessárias, lembrando que o exemplo de endereço /api/ pode variar de cliente para cliente conforme seu domínio.
- Primeiro antes de executar o serviço externo registroEntradaSaidaPadrao, deve ser gerado a chave de Autorização para saber mais clique aqui. (Aqui deve ser informado a Collection e como gerar o jwttoken)
- Para facilitar as configurações via Postman clique aqui para baixar a Collection, lembrando de alterar os registros conforme cada instituição.
- Authorization
Exemplo da Url: https://IP:PORTA/APLICACAO_API/v1/controlefrequencia/registroEntradaSaidaPadrao
Como deve ficar: https://qualidademssql.edusoft.inf.br/quaMssqlApi/v1/controlefrequencia/registroEntradaSaidaPadrao
- Headers
- Body
