Árvore de páginas


Objetivo

O objetivo do fluig SDK é auxiliar na criação de aplicativos móveis da plataforma fluig de forma simples e eficiente. Provendo facilitadores como mapeamento de chamadas de APIs, componentes de interfaces, fluxos integrados, ferramentas, etc.


Requisitos

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

  • iOS 10.3+
  • Swift 4.1+
  • Xcode 9.2+


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.1 Importar via CocoaPods
    1.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 

Caso não esteja familiarizado com o CocoaPods, siga os passos descritos na documentação para criar o arquivo Podfile necessário.

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

Podfile
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 um conjunto de subspecs específico, altere a dependência do seu Podfile.

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

Fique atento!

Alguns subspecs podem conter outros subspecs como dependência interna.


Importar manualmente 

Faça o download do SDK e adicione os arquivos framework no seu projeto.

Fique atento!

Caso importe o fluigSDKCore.framework no seu projeto, não esqueça de importar também o CommonCrypto.framework.


Para evitar problemas na importação manual, arraste os arquivos framework para dentro do Xcode na seção Embedded Binaries do target do seu projeto. Confira abaixo como efetuar esta etapa.

Adicionar um arquivo de configuração 

Qualquer configuração que o SDK necessite no momento da inicialização do seu aplicativo deve estar localizada em um arquivo de configuração dentro do seu projeto. Este arquivo deve ser do tipo property list 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.

fluigSdk.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>

Fique atento!

As chaves deste arquivo são case sensitive.


Caso esteja mais familiarizado com o editor padrão de property lists do Xcode, confira abaixo o mesmo exemplo de fluigSdk.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. 

Atenção!

Para a chamadas das APIs do fluig, é necessário autenticação na plataforma.