Configurações da Aplicação

Configuração do arquivo properties

O arquivo fsense.properties deve estar no mesmo diretório do JAR ou vc deve especificar o caminho completo para ele.

Credenciais da Organização

• Acesse o site http://app.fsense.com e faça login na sua conta.

Figura 1 - fSense - Administração - Organização

• No menu lateral, vá para Administração > Organização > Integrações. Na aba Integrações está localizado o card Integração com API do fSense onde estão as credenciais da organização.

Figura 2 - fSense - Administração - Organização - Integrações - Credenciais

Configure as credenciais no arquivo fsense.properties

Substitua o valores <you-client-id> e <you-client-secret> pelas as credenciais da sua organização obtidas no painel de Administração Online fSense, sem aspas e sem espaços.

    #CREDENCIAIS DA ORGANIZAÇÃO
    client.id=<you-client-id>
    client.secret=<you-client-secret>

Configurar a URL da API

Em seguida, é preciso definir a URL base da API de integração e a versão da API que será utilizada.

• Acesse o site API de Integração do fsense, para verificar a URL e a versão atual da documentação.

Figura 3 - API de Integração do fSense

A configuração é feita com base neste modelo, a URL base, seguido da versão da API.

Figura 4 - API de Integração do fSense - URL - versão da API

• Preencha as propriedades do arquivo fsense.properties como a referência abaixo:

    #URL DA API DE INTEGRAÇÃO - [https://api.fsense.io, https://api.fsense.com]
    api.base.url= http://api.fsense.com
    #versão da api - ["v1.0", "v2.0", "v3.0"]
    api.version=v3.0

Definir o Serviço

Para que a aplicação funcione corretamente, é necessário definir um serviço e um método a ser executado.

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

Configuração do Método

Para cada serviço, você deve especificar método a ser executado. Por exemplo para o AUTH_SERVICE, GET_ACCESS_TOKEN:

    #SERVICO A SER EXECUTADO
    service.name=AUTH_SERVICE
    #METODO DO SERVIÇO A SER EXECUTADO
    service.method=GET_ACCESS_TOKEN

Exemplos de Execução

Exemplo 1: Obter o token de acesso

• Configure o fsense.properties com:

      service.name=AUTH_SERVICE
      service.method=GET_ACCESS_TOKEN

• Execute:

      java -jar fsense-api-example.jar fsense.properties

• É possível executar o aplicativo passando o serviço e o método como parâmetro após o fsense.properties. Isto irá sobrescrever as propriedades existentes, desta maneira:

      java -jar fsense-api-example.jar fsense.properties service.name=AUTH_SERVICE service.method=GET_ACCESS_TOKEN

O Serviço e o método estão definidos, então, se tudo estiver configurado corretamente, o console da aplicação exibirá a resposta da API.

✅ Saída com sucesso

    ========================================================
    SELECTED SERVICE [AUTH_SERVICE]
    ========================================================
    SELECTED METHOD [GET_ACCESS_TOKEN]
    checking if token is valid?: false
    ========================================================
    Starting authentication process
    Getting access token
    Token received.
    1a1974a5-16ab-41a8-ad03-d25b1ff4d435
    ========================================================
    AUTHENTICATION SUCCESS
    ========================================================
    End of execution.

❌ Saída com erro

Caso as credenciais foram inseridas incorretas, o console exibirá uma mensagem vinda da API com o erro.

    ========================================================
    SELECTED SERVICE [AUTH_SERVICE]
    ========================================================
    SELECTED METHOD [GET_ACCESS_TOKEN]
    checking if token is valid?: false
    ========================================================
    Starting authentication process
    error: invalid_client
    error description: Bad client credentials
    Invalid credentials
    ========================================================
    AUTHENTICATION FAILED
    ========================================================
    End of execution.

Certifique-se seguir cada etapa e validar as configurações para que a aplicação funcione conforme o esperado.

Solução de Problemas

Erro "No service found for informed name"

• Verifique se o service.name está correto no arquivo de propriedades.
• Confira a lista de serviços disponíveis na saída do programa.

Erro "No method has been selected"

• Verifique se o service.method está configurado corretamente para o serviço selecionado.

Erros de conexão

• Verifique se a api.base.url está correta
• Configura sua conexão com a internet

Credenciais Inválidas

• Verifique se os valores do client.id e client.secret estão corretos.