# Getting Started

Follow this guide to set up your environment and integrate our SDK into your Android project.

## Integration Pre-requisites and Supported Hardware

## Pre-requisites
Before integrating with the Teya API, ensure the following requirements are met:

 **Debug Teya Card Machine**
    - A debug Teya card machine must be linked to a test account.
    - To obtain this, please contact your **Partnership Manager**.


---

## Supported Hardware Models

The following hardware models are currently supported for integration:

| Hardware Model | Notes |
|---|---|
| **Teya Pro**<br>_Victa Portable, A920 Pro, P2 Pro_ | Full support including printing |
| **Teya Go**<br>_N6 Pro Lite_ | No printer. Digital receipts only |
| **Teya Lite**<br>_Victa Mini_ | No printer. Digital receipts only |
| **Teya Connect**<br>_A35_ | No printer. Digital receipts only |

---

## Requirements

Our SDK is currently compatible with the following **minimum** versions:

| Component                 | Version(s) | Notes                                 |
|---------------------------|------------|---------------------------------------|
| **minSdkVersion**         | 21         | Android 5.0 and above                 |
| **compileSdkVersion**     | 37         |                                       |
| **Android Gradle Plugin** | 8.13.2     | 8.13.2 or newer                       |
| **Gradle**                | 8.13       |                                       |
| **Kotlin**                | 2.3.0      | Required only if already using Kotlin |


### Using Older Versions?

If you're using older versions and cannot upgrade, please contact your partnership manager or email us at partnersupport@teya.com and make sure to include the below information.

- The current versions of your android tools (compile SDK, min SDK, AGP and Kotlin)
- Any more useful information for the reason for not upgrading to the supported versions.

Your input helps us better understand real-world constraints so we can keep improving accordingly.

---

## Getting the SDK

Make sure your `settings.gradle(.kts)` includes the appropriate repository:

```kotlin
dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
}
````

Then, to include our SDK in your Android project, add the following to your `build.gradle(.kts)` file:

```kotlin
dependencies {
    // ...
    implementation("com.teya.epos:unified-sdk-all-in-one:<version>")
}
```

Replacing `<version>` with this one:

[![Maven (stable)](https://img.shields.io/badge/dynamic/xml?label=maven-central&style=for-the-badge&color=rgb(222,224,99)&url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fteya%2Fepos%2Funified-sdk%2Fmaven-metadata.xml&query=%2F%2Fmetadata%2Fversioning%2Fversions%2Fversion%5Bnot(contains(text()%2C%27-%27))%5D%5Blast()%5D)](https://central.sonatype.com/artifact/com.teya.epos/unified-sdk)