Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice
outlinetrue
exclude.*ndice
stylenone

Requisitos

Para utilizar o SDK Android, certifique-se que seu projeto atende os seguintes requisitos mínimos:

  • Android 5.0+ (API level 21+)
  • JDK 1.7+
  • Android Studio 3.0+
Informações
titleNota

Google tem depreciado o Eclipse como ferramenta de desenvolvimento em Android, portanto não oferecemos suporte para Eclipse.


Instalação

Para instalar o SDK em seu projeto, é necessário seguir os passos descritos a seguir:

  1. Importar o SDK pelo build.gradle 
  2. Adicionar as permissões necessárias no AndroidManifest 
  3. Adicionar um arquivo de configuração 
  4. Criar as classes necessárias
  5. Utilizar o fluxo de login


Importar o SDK pelo build.gradle 
Âncora
build
build

Adicione a URL do SDK no Maven no arquivo build.gradle do projeto.

Bloco de código
languagegroovy
titlebuild.gradle (project)
collapsetrue
allprojects {
    repositories {
        maven { url "https://dl.bintray.com/fluig/maven" }
    }
}

Adicionada a URL acima, adicione a dependência do SDK no arquivo build.gradle do aplicativo.

Bloco de código
languagegroovy
titlebuild.gradle (app)
collapsetrue
dependencies {
    implementation 'sdk.fluig.com:<nome_do_modulo>:<versao_do_sdk>'
}


Adicionar as permissões necessárias no AndroidManifest  
Âncora
permissoes
permissoes

O fluig SDK requer algumas permisssões e referências do arquivo AndroidManifest.xml da sua aplicação. Essas permissões permitem que o SDK monitore o estado de rede. Abaixo está um exemplo com um pacote chamado com.myapp.package. Substitua com o nome do seu próprio pacote ao mesclar com o manifesto de seu projeto.

Bloco de código
languagexml
titleAndroidManifest.xml
collapsetrue
<?xml version="1.0" encoding="utf-8"?>
<manifest
	xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.myapp.package">

    <!-- permissões padrão -->
	<uses-permission android:name="android.permission.INTERNET" />
	<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
	<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
	<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
	...
    <application>
		...
    </application>
</manifest>


Adicionar um arquivo de configuração 
Âncora
configuracao
configuracao

Qualquer configuração que o SDK necessite no momento de inicialização do seu aplicativo deve estar localizado em um arquivo de configuração no seu projeto. Dentro de seu projeto, este arquivo deve ser incluído dentro do diretório assets e deve ser um arquivo JSON chamado fluigSDKConfiguration. É possível criar mais de um arquivo de configuração, caso esteja desenvolvendo para outros clientes com customizações, contanto que crie flavors em seu projeto. Neste caso cada arquivo deverá ficar no diretório assets de cada flavor criado.

Atualmente a principal função deste arquivo é fornecer as chaves responsáveis pela renovação do token de acesso às APIs do fluig. Para criar as chaves que serão fornecidas no arquivo de configuração, siga os passos descritos aqui, na seção Criar Usuário Aplicativo.

O exemplo abaixo demonstra como deve ser o formato do arquivo JSON, note que as chaves deste arquivo são case sensitive.

Bloco de código
languagejs
titlefluigSDKConfiguration.json
collapsetrue
{
    "Authentication": {
        "Protocol": "OAuth1",
        "ConsumerKey": "<my_consumer_key>",
        "ConsumerSecret": "<my_consumer_secret>"
    }
}
Nota

Conforme novas funções forem atribuídas a esse arquivo de configuração, a documentação será atualizada.


Habilitando o SDK

Para que o SDK inicialize as configurações fornecidas no passo anterior,  é necessária a criação de uma classe de aplicação customizada que extenda de FluigSdkApplication. Esta classe é reponsável por iniciar todas as principais funções do SDK no momento que seu aplicativo iniciar. Segue abaixo um exemplo de como ficará essa classe de aplicação.

Bloco de código
languagejava
titleApplication.java
collapsetrue
import sdk.fluig.com.bll.core.base.view.application;


public class Application extends FluigSdkApplication {
  
    @Override
    public void onCreate() {
        super.onCreate();
        ...
    }
}

Lembre-se que ao criar uma classe de aplicação dentro de seu projeto, é necessário também informar no AndroidManifest.xml do seu projeto o nome da classe criada. No exemplo abaixo, o nome informado será .application.Application pois foi o nome escolhido foi Application localizado dentro do pacote application.

Bloco de código
languagexml
titleAndroidManifest.xml
collapsetrue
<?xml version="1.0" encoding="utf-8"?>
<manifest
    xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.myapp.package">
 
    <application
        android:name=".application.Application"
        android:label="@string/app_name"
        ... >
        ...
    </application>
</manifest>


Utilizar o fluxo de login

Este passo é opcional mas altamente recomendado, dado a complexidade do fluxo de login. Lembre-se que ao chamar as APIs do fluig, caso não esteja autenticado, estes serviços retornarão um erro. Para informações de como integrar o fluxo de login no seu projeto, clique aqui.