Aviso:

Para brindarle información de soporte completa de manera más rápida, el contenido de esta página ha sido traducido al español mediante traducción automática. Para consultar la información de soporte más precisa, consulte la versión en inglés de este contenido.

Configuración

Después de crear el proyecto de Catalyst y el proyecto Android, debes seguir estos pasos para configurar e integrar el paquete Android SDK con tu aplicación.

Paso 1: Registrar tu aplicación Android en Catalyst

Puedes comenzar creando un paquete para la aplicación Android en Catalyst para registrarla y descargando su archivo de configuración único.

  1. Haz clic en el ícono de Settings desde la consola de Catalyst en tu proyecto. catalyst_console_settings

  2. Ve a Developer Tools en Project Settings en el menú de configuración, luego haz clic en el mosaico Android. developer_tools_android_sdkAlternativamente, puedes hacer clic en el botón Add Package a continuación.


  1. Ingresa un nombre de paquete que lo identifique de forma única. Proporciona la URL para redirigir al usuario final después de que inicie sesión en la aplicación, como la Redirect URL. android_sdk_create_packageLos valores que ingreses aquí se completarán automáticamente en el archivo de configuración.
Nota: Un nombre de paquete se asociará de forma única con ese SO. Por lo tanto, no puedes crear paquetes con el mismo nombre para aplicaciones Android e iOS. Debes proporcionar valores únicos.
Asegúrate de que Android esté seleccionado como el tipo de SO.
  1. Haz clic en Create para crear el paquete de SDK móvil.

  2. La consola mostrará entonces una ventana desde donde puedes descargar el archivo de configuración. Haz clic en Download para descargar el archivo. android_sdk_package_successful El archivo se descargará con todas las configuraciones necesarias. Las propiedades de este archivo se explican en el siguiente paso.


Paso 2: Importar el archivo de configuración en tu proyecto Android

Catalyst proporciona dos entornos de trabajo para desarrollar y crear tus aplicaciones: un sandbox de Development y un entorno de Production en vivo. Puedes obtener más información sobre ellos en la página de ayuda de Entornos.

Cuando creas un paquete en la consola, inicialmente solo estará disponible para descargar el archivo de configuración del entorno de desarrollo, independientemente del entorno en el que estés trabajando actualmente. Puedes elegir descargar el archivo de configuración desde la consola para cualquier entorno en cualquier momento, una vez que se haya creado el paquete.

Los archivos de configuración de cada entorno se nombrarían como:

  • Development: app_configuration_development.properties
  • Production: app_configuration_production.properties

Según el entorno en el que estés trabajando, debes descargar y agregar el archivo correspondiente a la estructura de tu aplicación Android. Para obtener un archivo de configuración del entorno de producción, primero debes desplegar tu proyecto a producción, y luego descargar el archivo desde la sección de configuración de Developer Tools.

El archivo de configuración debe agregarse al directorio assets del módulo de tu aplicación Android. Normalmente, la carpeta assets se crea en el directorio app/src/main. android_sdk_android_studs Consulta la documentación oficial de Android para obtener ayuda detallada sobre los módulos de aplicaciones Android.


Propiedades del archivo app_configuration_development.properties/ app_configuration_production.properties

El archivo de configuración de la aplicación define las propiedades mencionadas en la tabla a continuación. Todos estos valores, excepto los encabezados de solicitud, se completan automáticamente según los detalles de tu proyecto o los estándares predeterminados.

Nota: Puedes consultar los enlaces especificados en la tabla para saber dónde puedes obtener estos valores.
Propiedad Tipo de dato Descripción
clientID String Identificador único de tu cliente de aplicación registrado en Catalyst. Se recibe en el archivo de configuración.
clientSecret String Valor secreto generado para un clientID específico, que se envía junto con las llamadas a la API. Se recibe en el archivo de configuración.
portalID String Identificador único recibido en el archivo de configuración
redirectUrl String La URL de callback de tu aplicación que proporcionaste al crear un paquete para ella en la consola, en el paso anterior
projectID Long El ID único de tu proyecto de Catalyst
apiBaseURL String La URL del servidor de Catalyst a través de la cual se llama a la API interna. Debes usar la URL correspondiente (URL de desarrollo o URL de producción), según el entorno en el que estés trabajando.
oauthScopes String Los scopes que serán utilizados por la aplicación para acceder a las APIs de Catalyst desde tu proyecto. Puedes encontrar los scopes de OAuth disponibles aquí.
requestHeaders String Los encabezados que serán enviados por el cliente en las solicitudes HTTP
Los valores de los encabezados de solicitud deben ser pares clave-valor individuales, separados por comas como: requestHeaders=key1:value1, key2:value2
serverTLD String El dominio de nivel superior del servidor de datos
Valores aceptados: AU, CN, COM, EU y IN
printStackTrace Boolean Te permite obtener un rastreo detallado de los logs, si el valor de printStackTrace se establece como 'true'. El valor predeterminado es 'false'.
minLogLevel String Te permite establecer las preferencias de logging para la aplicación
Valores aceptados: warnings, errors, information, debug, ALL
httpRequestMode String Define si las solicitudes HTTP son síncronas o asíncronas
Valores aceptados: SYNC, ASYNC
Valor predeterminado: ASYNC
connectTimeOut
InSec
Long El valor de tiempo de espera de conexión (en segundos) de la solicitud HTTP enviada desde el SDK
Si no se recibe una respuesta del servidor para la solicitud del cliente dentro de este tiempo, la conexión se terminará
readTimeOutInSec Long El valor de tiempo de espera de lectura (en segundos) de la solicitud HTTP enviada desde el SDK
Si no se reciben datos del servidor dentro de este tiempo, la conexión se terminará
writeTimeOutInSec Long El valor de tiempo de espera de escritura (en segundos) de la solicitud HTTP enviada desde el SDK
Si la solicitud no logra escribir o enviar los datos de la solicitud al servidor dentro de este tiempo, la conexión se terminará
JWTClientID String La propiedad de ID de cliente del token de servidor personalizado (token JSON Web Token) generado para la autenticación de terceros que se pasa al cliente
JWTClientSecret String La propiedad de secreto de cliente del token de servidor personalizado (token JSON Web Token) generado para la autenticación de terceros que se pasa al cliente
Nota:
  • Si se modifican los valores de clientID, clientSecret, projectID o portalID en el archivo de configuración, esto afectará el funcionamiento del SDK y tu aplicación Android. Si deseas cambiar alguna de estas configuraciones, puedes crear un nuevo paquete para el proyecto requerido desde la sección Developer Tools y descargar un nuevo archivo de configuración para el entorno correspondiente, luego agregarlo al directorio assets en la estructura de tu aplicación.

  • Los valores de las propiedades que se completan en el archivo de configuración descargado se pueden acceder dinámicamente usando el objeto ZCatalystApp.configs.


Paso 3: Agregar Catalyst Android SDK en tu aplicación

El siguiente paso es incluir el paquete SDK en tu aplicación. Catalyst Android SDK está disponible como una biblioteca Gradle. Puedes agregar el SDK en tu proyecto Android accediendo al repositorio Maven que contiene la biblioteca, de la siguiente manera:

  1. Agrega el fragmento de código que se muestra a continuación al archivo build.gradle a nivel de proyecto en la estructura de tu aplicación Android:
copy
maven {
		url "https://maven.zohodl.com/"
}
  1. Agrega el fragmento de código que se muestra a continuación al archivo build.gradle a nivel de aplicación en la estructura de tu aplicación Android:
copy
dependencies {
	    implementation 'com.zoho.catalyst:android-sdk:3.0.1'
}

Paso 4: Configurar la redirección de inicio de sesión de la aplicación

Cuando un usuario inicia sesión en tu aplicación correctamente, será redirigido a la pantalla principal de tu aplicación. Este inicio de sesión y redirección del usuario es gestionado por el SDK de Catalyst.

Para asegurar que esta redirección se gestione correctamente, incluye la cadena que se muestra a continuación en el archivo strings.xml de tu aplicación Android:

copy
<string name="url_scheme">{redirection_url}</string>

El archivo strings.xml se crea automáticamente cuando creas el proyecto Android. Puedes encontrarlo navegando a app/src/main/res/values en la estructura de tu aplicación. El archivo ya contendrá la definición de cadena para el nombre de tu aplicación. Incluye esta cadena junto con ella.

Debes pasar la Redirection URL que configuraste al crear el paquete para tu aplicación en Catalyst, en lugar de redirection_url en este código.


Paso 5: Establecer los permisos necesarios

Catalyst SDK requiere que los siguientes permisos de la aplicación estén habilitados para asegurar que tu aplicación funcione sin problemas y proporcionar una experiencia de usuario fluida:

  • INTERNET: Para ejecutar las APIs de Catalyst
  • ACCESS_NETWORK_STATE: Para gestionar fallos de red

Para habilitar estos permisos, debes declararlos en el archivo AndroidManifest.xml, como se muestra a continuación:

copy
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>

Puedes encontrar el archivo AndroidManifest.xml navegando a app/src/main en la estructura de tu aplicación.

Todas las configuraciones necesarias para agregar e implementar Catalyst Android SDK están completas. Después de ejecutar todos los pasos mencionados anteriormente, debes compilar tu proyecto. Si la compilación de Gradle es exitosa, tu aplicación podrá acceder a los componentes de Catalyst Android SDK.


Paso 6: Inicializar el SDK

Debes inicializar el SDK de Catalyst para habilitar el funcionamiento de los métodos y funcionalidades definidos en el paquete SDK.

Por lo tanto, antes de configurar tu aplicación para consumir los métodos del SDK, debes inicializar el SDK mediante uno de los siguientes métodos:

Método 1: Especificando el entorno

El Environment indica si la aplicación está operando en el entorno de Development o Production. De manera similar a incluir el archivo de configuración correspondiente (app_configuration_development.properties/ app_configuration_production.properties) según el entorno en el proyecto de tu aplicación, debes inicializar el SDK para el entorno correspondiente.

En este método, debes establecer la configuración requerida y especificar el Environment de tu aplicación como DEVELOPMENT o PRODUCTION, y pasarlo al método init() a través de la clase ZCatalystApp como se muestra a continuación:

copy
ZCatalystApp.init(
            context: Context,
            Environment: ZCatalystSDKConfigs.Environment.{DEVELOPMENT}
        ): ZCatalystApp

Método 2: Sin especificar el entorno

Si no se especifica el Environment en la inicialización del SDK, se considerará como PRODUCTION por defecto. Por lo tanto, si tu aplicación está operando en el entorno de Production, puedes inicializar el SDK directamente sin especificar el Environment de la siguiente manera:

copy
ZCatalystApp.init(context: Context): ZCatalystApp

Nota: * Si realizas algún cambio en el archivo app_configuration_development.properties o app_configuration_production.properties, debes reinicializar el SDK.
  • Si configuras una autenticación de terceros para tu aplicación Android, también necesitarás reinicializar el SDK ya que se agregarán nuevas propiedades en este archivo de configuración. Puedes obtener más información en esta página de ayuda.

Si el SDK se inicializa correctamente, la aplicación invocará los métodos de los componentes y funcionará según lo previsto.

Última actualización 2026-03-20 21:51:56 +0530 IST