1 - Adicionar ao Projeto

Configure seu ambiente de desenvolvimento com as ferramentas e versões recomendadas para integrar o SDK Tap to Pay no Android.

Configurando o ambiente

🛠️ IDE (Ambiente de Desenvolvimento Integrado)

Utilize o Android Studio na versão estável mais recente. O suporte ao Android Gradle Plugin atualizado é essencial para o funcionamento correto do SDK.

💻 Linguagem

O SDK é compatível com Kotlin e Java. Recomendamos Kotlin 1.5 ou superior para aproveitar os recursos modernos da linguagem e compatibilidade total com os exemplos do SDK.

📘
Para consultar as versões exatas utilizadas no projeto de referência, verifique o arquivo build.gradle do Aplicativo de Exemplo.

Configuração do projeto

Configure as dependências e permissões do seu projeto para integrar o SDK Tap to Pay no Android.

Configuração do Gradle

1. Adicionar repositório (nível do projeto)

No arquivo settings.gradle (ou build.gradle do projeto), adicione o repositório Maven do GitHub da Zoop.

🔒
Para baixar os artefatos, autentique no GitHub Packages usando seu usuário e um Personal Access Token (PAT) com permissão de leitura de pacotes públicos (read:packages).

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.pkg.github.com/getzoop/zoop-package-public")
            credentials {
                username = "SEU_USUARIO_GITHUB"
                password = "SEU_GITHUB_PAT"
            }
        }
    }
}

💡
Dúvidas sobre como gerar o PAT? Consulte o guia em nosso repositório público.

2. Adicionar dependências (nível do módulo)

No arquivo build.gradle do seu módulo (geralmente app/build.gradle), adicione as configurações e dependências:

android {
    // ...
    buildFeatures {
        viewBinding = true   // O SDK utiliza ViewBinding em algumas interfaces
        buildConfig = true
    }
}

dependencies {
    val zoopSdkVersion = "2.1.3" // Verifique a versão mais recente

    // Dependências do SDK (Debug e Release)
    debugImplementation("com.zoop.sdk:taponphone-staging-debug:$zoopSdkVersion")
    releaseImplementation("com.zoop.sdk:taponphone-production-release:$zoopSdkVersion")

    // Dependências transitivas obrigatórias
    implementation("androidx.appcompat:appcompat:1.7.0")
    implementation("androidx.core:core-ktx:1.13.0")
    implementation("com.airbnb.android:lottie:6.4.1")
    implementation("androidx.security:security-crypto:1.0.0")
    implementation("com.squareup.retrofit2:retrofit:2.9.0")
    implementation("com.squareup.retrofit2:converter-gson:2.9.0")
    runtimeOnly("org.jetbrains.kotlin:kotlin-reflect:1.9.22")
}

Permissões do Android

Adicione as seguintes permissões ao arquivo AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.seu.pacote">

    <!-- Comunicação com a API -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

    <!-- Leitura do cartão por aproximação -->
    <uses-permission android:name="android.permission.NFC" />

    <!-- Feedback tátil durante a transação -->
    <uses-permission android:name="android.permission.VIBRATE" />

    <application>
        <!-- ... -->
    </application>
</manifest>

Permissão	Finalidade
`INTERNET`	Comunicação com os servidores da Zoop
`ACCESS_NETWORK_STATE`	Verificação do estado da conexão de rede
`NFC`	Leitura de cartão por aproximação (Tap to Pay)
`VIBRATE`	Feedback tátil para o usuário durante a transação