Índice

O fluig SDK para iOS é a maneira mais fácil de integrar seu aplicativo com a plataforma do fluig e está dividido em camadas:

• fluigSDKCore: Acesso a todas as APIs REST automaticamente assinadas usando OAuth.
• fluigSDKFlows: API + camada de negócio.  Disponibilizando:
  • Banco de dados;
  • Cache;
  • Gerenciamento de servidores e usuários.
    
    
• fluigSDKUi: Camada de negócio + camada de interface do usuário. Disponibilizando:
  • Componentes de interface como: botões, listas, visões, etc;
  • Telas completas como Login, Timeline, Process, etc.

Requisitos

Os requisitos necessários são:

• iOS 10.0+
• Swift 4.0+
• Xcode 9.0+

Instalação

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

1. Importar o SDK no seu projeto
   1. Importar via CocoaPods
   2. Importar manualmente
2. Adicionar um arquivo de configuração
3. Utilizar o fluxo de login

Importar o SDK no seu projeto

É possível importar o SDK de duas maneiras, via CocoaPods ou manualmente. É recomendada a importação via CocoaPods por ser a opção mais simples.

Importar via CocoaPods

Para criar o arquivo Podfile necessário, sigas os passos descritos na documentação oficial do CocoaPods.

Insira a dependência do SDK no arquivo Podfile criado. O exemplo abaixo irá adicionar todos os subspecs do projeto.

target 'MyApp' do
  use_frameworks!

  # Pods for MyApp
  pod 'fluigsdk', { :git => 'https://github.com/fluig/fluigsdkios', :tag => '0.2.1' }

  target 'MyAppTests' do
    inherit! :search_paths
    # Pods for testing
  end

end

Caso deseje importar somente algum subspec específico, altere a dependência do seu Podfile.

# Pods for MyApp
pod 'fluigsdk/<subspec_desejado>', { :git => 'https://github.com/fluig/fluigsdkios', :tag => '0.2.1' }

Manualmente

Você também pode integrar o fluigSDK manualmente no seu projeto baixando os pacotes da página do fluigSDK para iOS(inserir link) e adicione os arquivos .framework no seu projeto.

Adicionar um arquivo de configuração

Qualquer configuração que o SDK necessite no momento de inicialização do seu aplicativo deve estar localizada em um arquivo de configuração dentro do seu projeto. Este arquivo deve ser do tipo plist e ser chamado fluigSdk.

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 em Criar Usuário Aplicativo.

O exemplo abaixo demonstra como deve ser a formatação do arquivo plist.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>consumerKey</key>
	<string>my_consumer_key</string>
	<key>consumerSecret</key>
	<string>my_consumer_secret</string>
</dict>
</plist>

Utilizar o fluxo de login

Este passo é opcional mas altamente recomendado devido a complexidade do fluxo de login. Acesse a documentação e obtenha todas as informações necessárias para adicionar este recurso ao seu projeto.