1 - Adicionar ao projeto

Adicione o TapOnPhoneSDK ao seu projeto iOS e valide a integração com Swift Package Manager, CocoaPods ou importação manual do .xcframework.

Configurando o ambiente

Você pode adicionar e importar o TapOnPhoneSDK em projetos com iOS 14 ou superior. Os métodos do SDK ficam disponíveis para uso a partir de iOS 16.4.

🧪

Para vender em staging ou sandbox, configure uma conta sandbox da Apple como conta principal do iCloud no iPhone usado nos testes.

⚠️

Para usar o ambiente de produção, instale o app pela App Store ou TestFlight. Não é possível debugar o app em produção.

Se você precisar de uma referência de implementação, siga o aplicativo de exemplo do SDK iOS.

Habilite as capabilities no Xcode

Para o Tap to Pay funcionar corretamente, habilite estas capabilities no target do aplicativo:

• Near Field Communication Tag Reading
• Tap to Pay on iPhone

ℹ️

A capability Tap to Pay on iPhone só aparece depois que a Apple aprova o entitlement (permissão oficial para uso do Tap to Pay on iPhone) configurado nos requisitos da integração. Antes de continuar, consulte a página Tap to Pay no iOS.

Como adicionar capabilities

• Abra o projeto no Xcode em que você está integrando o TapOnPhoneSDK.
• No navegador de projetos, clique no nome do projeto.
• Escolha o target em que o Tap to Pay será habilitado.
• Abra a aba Signing & Capabilities.
• Clique no botão + no canto superior esquerdo.
• Pesquise por Near e selecione Near Field Communication Tag Reading.
• Pesquise por Tap to Pay e selecione Tap to Pay on iPhone.

Métodos de instalação

Escolha um único método para integrar o SDK ao projeto.

Swift Package Manager

Use este fluxo para adicionar o TapOnPhoneSDK diretamente pelo gerenciador de pacotes do Xcode.

Pré-requisitos

• Instale uma versão do Xcode compatível com Swift Package Manager.
• Tenha uma conta no GitHub com permissão para criar tokens.
• Use o repositório público do SDK: getzoop/zoop-package-public.

1. Abra o projeto no Xcode

Abra no Xcode o projeto em que você quer adicionar o TapOnPhoneSDK.

2. Acesse Package Dependencies

1. No navegador de projetos, clique no nome do projeto.
2. Na barra superior, abra a aba Package Dependencies.

3. Adicione uma conta GitHub ao Xcode

1. Clique no botão + para adicionar uma nova conta.
2. Selecione Add Account Source Control.
3. Escolha GitHub.

4. Autentique com GitHub

1. Informe seu usuário do GitHub.
2. Cole o seu Personal Access Token (PAT).

O PAT deve ter, no mínimo, permissão para ler e obter pacotes ou artefatos de repositórios públicos.

Se você tiver dúvidas sobre o PAT, consulte o README do repositório público: getzoop/zoop-package-public.

5. Adicione o repositório e selecione a versão do SDK

1. Copie a URL https://github.com/getzoop/zoop-package-public.
2. Cole a URL no campo de busca do Xcode.
3. Clique em Adicionar Pacote.
4. Escolha a versão do SDK.
5. Altere Dependency Rule para branch.
6. Informe a branch correspondente à versão desejada.

Para este exemplo, use a branch release-zoop-sdk-taponphone-ios-1.1.1.

O padrão de branch do Tap to Pay iOS é:

release-zoop-sdk-taponphone-ios-{versão}

6. Confirme a adição do pacote

Depois da configuração, confirme que o SDK aparece na lista de dependências do Xcode.

7. Valide a integração

Importe o SDK em um arquivo Swift e confirme que o projeto compila:

import UIKit
import TapOnPhoneSDK

final class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
    }
}

Resultado esperado:

• o Xcode resolve a dependência sem erro
• import TapOnPhoneSDK é reconhecido
• o projeto compila com sucesso

CocoaPods

Use este fluxo para integrar o TapOnPhoneSDK pelo CocoaPods apontando para o repositório Git público.

Pré-requisitos

• Tenha uma conta no GitHub.
• Use o repositório público do SDK: getzoop/zoop-package-public.

1. Escolha a versão do SDK

1. Consulte a versão mais atual disponível no repositório.
2. Identifique a branch correspondente à versão que você quer instalar.

O padrão de branch é:

release-zoop-sdk-taponphone-ios-{versão}

Exemplo:

release-zoop-sdk-taponphone-ios-1.3.0

Use sempre a versão mais recente para receber correções e melhorias.

2. Configure o Podfile

No diretório raiz do projeto, abra ou crie o arquivo Podfile e adicione esta configuração:

platform :ios, '14.0'

target 'SeuProjeto' do
  use_frameworks!

  # Usa o repositório público e fixa a branch da versão escolhida.
  pod 'TapOnPhone-iOS', :git => 'https://github.com/getzoop/zoop-package-public.git', :branch => 'release-zoop-sdk-taponphone-ios-1.3.0'
end

Substitua 'SeuProjeto' pelo nome do seu target no Xcode.

Substitua a branch release-zoop-sdk-taponphone-ios-1.3.0 pela versão que você escolheu no passo anterior.

3. Instale as dependências

No terminal, vá até o diretório do projeto e execute:

pod install

Optional: atualize o CocoaPods

Se você encontrar erros durante a instalação, atualize o CocoaPods:

sudo gem install cocoapods

4. Abra o projeto pelo .xcworkspace

Depois da instalação, abra o workspace gerado pelo CocoaPods:

open SeuProjeto.xcworkspace

5. Valide a integração

Importe o SDK em um arquivo Swift e faça um teste de compilação:

import UIKit
import TapOnPhoneSDK

final class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
    }
}

Resultado esperado:

• o workspace abre com as dependências instaladas
• import TapOnPhoneSDK é reconhecido
• o projeto compila com sucesso

Importação manual

Use este fluxo quando você quiser integrar o SDK adicionando o arquivo TapOnPhoneSDK.xcframework diretamente ao projeto.

Pré-requisitos

• Baixe o arquivo disponibilizado na release.
• Extraia o arquivo compactado.
• Separe o arquivo TapOnPhoneSDK.xcframework.

1. Arraste o .xcframework para o Xcode

Abra o projeto no Xcode e arraste o arquivo TapOnPhoneSDK.xcframework para a seção Frameworks, Libraries, and Embedded Content.

Marque a opção Copy items if needed.

2. Confirme as configurações de embed

No target do aplicativo, abra a aba General e confirme que o framework está listado em Frameworks, Libraries, and Embedded Content com a opção Embed & Sign.

3. Valide a integração

Importe o SDK em um arquivo Swift e confirme que o framework foi reconhecido:

import UIKit
import TapOnPhoneSDK

final class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
    }
}

Resultado esperado:

• o framework aparece no target com Embed & Sign
• import TapOnPhoneSDK é reconhecido
• o projeto compila com sucesso

Próximo passo

Depois de adicionar o SDK ao projeto, siga para a próxima etapa da integração para inicializar o Tap to Pay e realizar uma transação.