Configurações da Aplicação

Configuração do arquivo Properties

A configuração correta do arquivo fsense.properties é essencial para o funcionamento da aplicação exemplo de integração.

Localização do Arquivo

O arquivo fsense.properties pode ser localizado no diretório src/main/resources da aplicação como no exemplo abaixo:

Eclipse - Arquivo fsense.properties

Configuração das Credenciais da Organização

Obtendo as Credenciais

• 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. Na aba Organização está localizado o card Integrações onde estão as credenciais da organização.

Figura 2 - fSense - Administração - Organização - Credenciais

Configurando as Credenciais

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

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

Definir a URL de domínio

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

Configurando a URL da API

• 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 o serviço a ser executado.

Se executarmos a aplicação, uma lista de serviços disponíveis será exibida se nenhum serviço for informado.

    ================================================
    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]
    ================================================

Por exemplo, para selecionar o serviço AUTH_SERVICE, que acessa o endpoint oauth/token para obter o token de acesso, adicione a seguinte configuração na propriedade service.name:

    #SERVICO A SER EXECUTADO
    service.name=AUTH_SERVICE

Ao definir o serviço, você deve definir o método a ser utilizado;

    ==============================================
    SELECTED SERVICE [AUTH_SERVICE]
    ==============================================
    SELECTED METHOD []
    No method has been selected.
    ==============================================
    Available methods: 
    [GET_ACCESS_TOKEN]
    ==============================================
    End of execution.

Definir o Método

Para obter o token de acesso, defina o método GET_ACCESS_TOKEN:

    #SERVICO A SER EXECUTADO
    service.name=AUTH_SERVICE

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

Execução e Resultados

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.

• RESPOSTA 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.

• RESPOSTA 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.