Documentación

Primeros Pasos - Android

Suggest Edits

Comienza integrando el SDK de Android de DEUNA en tu aplicación con esta guía paso a paso. Revisa los requisitos, configura e instala el SDK, y selecciona la integración que mejor se adapte a tus necesidades.

Versión Estable: 2.8.11

Requisitos

Paso 1: Revisar los Requisitos para Utilizar el SDK

Para utilizar el SDK de Android de DEUNA, debes cumplir con los siguientes requisitos:

  • Tu proyecto debe usar una versión mínima de la API 22 de android o superior

  1. Conocimientos en desarrollo Android con Kotlin o Java.

  2. Una cuenta activa en DEUNA. (Para obtener una, contacta a [email protected])

  3. Credenciales válidas de DEUNA. (Solicítalas en [email protected])

  4. Configuraciones mínimas en tu proyecto Android:

    • La SDK DEUNA Android precisa que su minSdkVersion sea 22 o superior.
    • Tu proyecto debe tener habilitado Java 8 y usar AndroidX en lugar de bibliotecas de soporte anteriores.
    • La versión de Android-gradle-plugin debe ser 4.0.0 o superior.

Compatibilidad con dispositivos Huawei (HarmonyOS)

El SDK de DEUNA también es compatible con dispositivos Huawei con HarmonyOS 2.0 o superior.


Instalación

Paso 2: Agregar el repositorio JitPack

En tu archivo raíz settings.gradle agrega el repositorio de jitpack en el bloque dependencyResolutionManagement

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } // <-- AGREGAR ESTA LINEA
    }
}

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { setUrl("https://jitpack.io") } // <-- AGREGAR ESTA LINEA
    }
}

NOTA: Para proyectos android que no tienen el bloque dependencyResolutionManagement en el archivo settings.gradle se debe agregar el repositorio de jitpack en el bloque repositories que se puede encontrar en el archivo raíz build.gradle o en el archivo app/build.gradle

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' } // <-- AGREGAR ESTA LINEA
	}
}

Paso 3: Configurar el Archivo build.gradle

En tu proyecto Android, abre el archivo app/build.gradle. Tu proyecto debe usar una versión mínima de la API 22 de Android o superior.

android {
   ...
    defaultConfig {
      ...
        minSdk 22 // O superior
      ...
    }
}

Paso 4: Agregar las Dependencias

Agrega las siguientes dependencias en el archivo app/build.gradle de tu proyecto:

dependencies {
   .
   .
   .
   implementation 'com.squareup.retrofit2:retrofit:2.9.0'
   implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0'
   implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
   implementation 'com.github.deuna-developers:deuna-sdk-android:2.8.11' // DEUNA SDK
}

dependencies {
   .
   .
   .
   implementation("com.squareup.retrofit2:retrofit:2.9.0")
   implementation("com.squareup.okhttp3:logging-interceptor:4.12.0")
   implementation("com.squareup.retrofit2:converter-gson:2.9.0")
   implementation("com.github.deuna-developers:deuna-sdk-android:2.8.11") // DEUNA SDK
}

Sincroniza tu proyecto y con esto ya tienes agregado el SDK de DEUNA en tu proyecto. Te recomendamos probar las funciones del SDK en un entorno de desarrollo para validar su correcto funcionamiento antes de lanzar tu aplicación.

🚧

NOTA: Si estas actualizando el sdk de DEUNA de una versión previa a la 2.5.1 se recomienda limpiar el cache de Android Studio


Inicialización

Paso 5: Inicializa el SDK

Para usar el SDK necesitas inicializar el SDK o crear una instancia de la clase DeunaSDK

Mediante Inicialización

// Inicializa el SDK mediante la creación de un singleton
DeunaSDK.initialize(
    environment = Environment.SANDBOX, // Ambiente de pruebas (Environment.SANDBOX) o producción (Environment.PRODUCTION)
    publicApiKey = "YOUR_PUBLIC_API_KEY" // Llave pública proporcionada por DEUNA
)

// Ahora puedes usar el SDK mediante el uso de una instancia compartida de la clase DeunaSDK
DeunaSDK.shared

// Ejemplo
DeunaSDK.shared.initCheckout(...)

Creación de una Instancia

val deunaSDK = DeunaSDK(
   environment = Environment.SANDBOX, // Ambiente de pruebas (Environment.SANDBOX) o producción (Environment.PRODUCTION)
   publicApiKey = "YOUR_PUBLIC_API_KEY" // Llave pública proporcionada por DEUNA
)
// Uso del SDK
deunaSDK.initCheckout(...)

Seleccionar el Componente que Deseas Utilizar

Paso 6: Elige la Integración

Actualmente, los SDK móviles permiten usar los siguientes componentes:

Widget de Pagos

El Widget de Pagos permite a los usuarios realizar pagos de forma rápida y segura directamente desde tu aplicación. Con este componente, puedes integrar un flujo de pago completo en tu app.

Para más detalles, consulta la documentación del Widget de Pagos.

Widget de Checkout

Permite al comercio implementar un checkout completo incluyendo manejo de usuarios, OTP, información de envío y pagos. Esta integración simplifica el proceso de checkout en tu aplicación.

Para más detalles, consulta la documentación del Widget de Checkout

Widget para Guardar Tarjetas (Vault Widget)

Este componente permite a los usuarios guardar tarjetas de forma segura para futuras transacciones. Es ideal para aplicaciones que requieren pagos recurrentes o que desean simplificar el proceso de pago para los usuarios.

Para más detalles, consulta la documentación del Widget para Guardar Tarjetas.

Al seleccionar uno de estos componentes, podrás continuar con el proceso de integración siguiendo las instrucciones específicas proporcionadas en los enlaces.

Updated 4 days ago