Guia Exemplo de Integração

Este guia explica de maneira simples, prática e direta de interagir com a API de Integração do fSense. Ele pode ser utilizado para testes, simulações, auditorias ou como modelo para futuras automações.

Introdução​

Este guia apresenta uma aplicação de console desenvolvida em Java, distribuída como um arquivo .jar executável, desenvolvida para demonstrar a integração com a API de integração do fSense.

A aplicação permite interações práticas com a API como:

  • internalização de dados (equipes, pessoas, jornadas, feriados, etc.)
  • Exportação de relatórios em formato CSV
  • Integração com banco de dados
  • Visualização de logs, mensagens, retornos da API diretamente no console

Com este executável você poderá validar chamadas e simular interações com a API do fSense de maneira rápida e independente do ambiente de desenvolvimento.

AVISO IMPORTANTE

Esta é uma aplicação de exemplo, fornecida apenas como material de apoio para demonstrar o uso da API de integração do fSense. Não oferecemos Suporte Técnico para esta aplicação, utilize apenas como referência para testes, validações e estudos.

Principais Funcionalidades​

  • Chamadas HTTP à API fSense: Comunicação direta com os endpoints da API.
  • Processamento de Dados de Resposta: Respostas são processadas de forma clara no console.
  • Internalização de dados: Suporte para internalização de Equipes, Pessoas, Jornadas, Alterações de jornadas, acréscimos de jornada, feriados, calendários e mais.
  • Exportação de Relatórios em CSV: Geração de arquivos CSV, para análise e auditoria.
  • Integração com Banco de Dados: Exemplos de sincronização com bancos de dados como MySQL, PostgreSQL, SQL Server. Para mais informações sobre essa integração, consulte o link fornecido no tópico específico
DICA

Para obter Detalhes sobre como configurar a Integração com bancos de dados, consulte o link a seguir: Integração com Banco de Dados

Requisitos​

Antes de executar o aplicativo, certifique-se de que o ambiente possui os seguintes componentes:

  • Java JDK 11 ou superior (preferencial JDK 11) - O aplicativo foi desenvolvido para ser executado em um ambiente Java, garantindo a compatibilidade com JDK 11 ou versões mais recentes. Recomendamos a utilização do JDK 11 para uma experiência ideal.
  • Servidor de Banco de Dados (opcional) - Caso utilização com Banco de Dados, é necessário um servidor de banco de dados como:
    • MySQL Server,
    • PostgreSQL
    • SQLServer.
  • Cliente SGBD(Sistema de Gerenciamento de Banco de Dados) - Para administração e visualização dos dados o banco, recomendamos ferramentas como:
    • MySQL Workbench
    • pgAdmin
    • DBeaver
CONFIGURAÇÃO ADICIONAL

Se a integração com o banco de dados for necessária, consulte o tópico específico sobre integração de banco de dados para obter informações detalhadas e orientações de configuração.

Integração com Banco de Dados

Download e Execução​

fsense-example-jar

Faça o download do pacote que inclui o executável .jar, o arquivo de propriedades e os demais recursos, e salve-o no diretório de sua preferência clicando no link abaixo.

Arquivo de Configuração​

A aplicação requer um arquivo de propriedades para configuração inicial. O arquivo fsense.properties é fornecido no pacote de download da aplicação, contendo todas as propriedades em branco para configuração de acordo com a necessidade.

Executando a aplicação​

Para executar a aplicação, abra o terminal na pasta da aplicação, e utilize o seguinte comando:

    java -jar fsense-api-example fsense.properties

Primeiro Teste​

Após a execução, se tudo estiver correto, o console exibirá a seguinte mensagem:

    ======================================================
    SELECTED SERVICE []
    ======================================================
    No service found for informed name: 
    ======================================================
    Available services:
    [LOGIN_HISTORY_SERVICE]
    [PERSON_SERVICE]
    [ACTIVITY_SERVICE]
    [EVENT_SERVICE]
    [WORKDAY_SERVICE]
    [CALENDAR_SERVICE]
    [CATEGORY_SERVICE]   
    [DATABASE_TEST_SERVICE]
    [TEAM_SERVICE]
    [WORKDAY_OVERRIDE_SERVICE]
    [WORKDAY_PROROGATION_SERVICE]
    [HOLIDAY_SERVICE]
    [KEYSTROKES_SERVICE]
    [AUTH_SERVICE]
    ======================================================

✅ Se foi exibida essa mensagem:​

Seu ambiente está corretamente configurado

❌ Se não foi exibida:​

Revise:

  • Se o Java está instalado e configurado no PATH
  • Se o arquivo fsense.properties foi informado corretamente.