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 iOS, debes seguir estos pasos para configurar e integrar el paquete del SDK de iOS con tu aplicación.

Paso 1: Registrar tu aplicación iOS con Catalyst

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

  1. Haz clic en el Settings icon desde tu consola de Catalyst en tu proyecto. catalyst_sdk_android_settings_icon

  2. Navega a Developer Tools bajo Project Settings en el menú de configuración, luego haz clic en el tile de iOS. ios_sdk_all_package Alternativamente, puedes hacer clic en el botón Add Package a continuación.

  3. Ingresa un nombre de paquete que lo identifique de manera única. Proporciona la URL para redirigir al usuario final después de que inicie sesión en la aplicación, como la URL de redirección. ios_sdk_create_package Los valores que ingreses aquí se completarán automáticamente en el archivo de configuración.

Nota: Un nombre de paquete se asociará de manera única con ese sistema operativo. Por lo tanto, no puedes crear paquetes con el mismo nombre para aplicaciones Android e iOS. Debes proporcionar valores únicos.

Asegúrate de que iOS esté seleccionado como el tipo de sistema operativo.

  1. Haz clic en Create para crear el paquete del 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. ios_sdk_package_created

El archivo se descargará con todas las configuraciones requeridas. Las propiedades en este archivo se explican en el siguiente paso.

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

Catalyst proporciona dos entornos de trabajo para desarrollar y construir tus aplicaciones: un sandbox de Development y un entorno de Production en vivo. Puedes aprender más sobre ellos en la página de ayuda de entornos.

Cuando creas un paquete en la consola, solo el archivo de configuración del entorno de desarrollo estará disponible para descarga inicialmente, 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 el paquete haya sido creado.

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

  • Development: AppConfigurationDevelopment.plist
  • Production: AppConfigurationProduction.plist

Según el entorno en el que estés trabajando, debes descargar y agregar el archivo apropiado a Targets -> Runner en tu proyecto iOS. 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 a Targets -> Runner de tu proyecto iOS. catalyst_sdk_ios_properties_file

Consulta la documentación oficial de iOS para obtener ayuda detallada sobre la estructura del proyecto iOS.

Propiedades del archivo AppConfigurationDevelopment.plist/ AppConfigurationProduction.plist

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.
ClientSecretID String Valor secreto generado para un clientID específico, que se pasa 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
RedirectURLScheme String La URL de callback de tu aplicación que proporcionaste al crear un paquete 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 apropiada (URL de desarrollo o URL de producción), según el entorno en el que estés trabajando.
APIVersion String Versión de la API
OauthScopes String Los ámbitos que serían utilizados por la aplicación para acceder a las APIs de Catalyst desde tu proyecto. Puedes encontrar los ámbitos OAuth disponibles aquí.
RequestHeaders String Los encabezados que serían 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 aceptables: AU, CN, COM, EU y IN
MinLogLevel String Te permite establecer las preferencias de registro para la aplicación
Valores aceptables: warnings, errors, information, debug, ALL
TurnLoggerOn Boolean Activa el logger según el valor
Valores aceptables: true, false
RequestTimeOut Double La duración de tiempo (en segundos) que una tarea debe esperar para que lleguen datos adicionales antes de desistir
X-Catalyst-Environment String El entorno (development o production) para el cual se descargó el archivo de configuración
X-CATALYST-USER String El rol de usuario del usuario de la aplicación
AccountsPortalDomain String Dominio del portal de tu cuenta de Zoho
notificationAppID String ID generado por Catalyst después de inscribirte en Push Notifications para tu aplicación iOS
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 los valores de clientID, clientSecretID, projectID o portalID se modifican en el archivo de configuración, afectará el funcionamiento del SDK y tu aplicación iOS. Si deseas cambiar alguna de estas configuraciones, puedes crear un nuevo paquete para el proyecto requerido desde la sección de Developer Tools y descargar un nuevo archivo de configuración para el entorno apropiado, y agregarlo a tu proyecto iOS.

  • 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 el SDK de iOS de Catalyst en tu aplicación

El siguiente paso es incluir el paquete del SDK en tu aplicación. Puedes instalar las bibliotecas del SDK de Catalyst usando CocoaPods.

Para agregar el SDK de iOS de Catalyst como dependencia a tu proyecto nuevo o existente:

  1. Inserta el fragmento de código dado a continuación en el Podfile de tu proyecto, bajo el target de tu aplicación:
copy
pod 'ZCatalyst', :git =>'https://github.com/zoho/Catalyst-iOS-SDK.git', :tag => '2.2.2'
  1. Ejecuta el comando pod install desde la terminal de tu sistema.

Esto instalará el pod y el SDK de iOS de Catalyst se agregará a tu aplicación iOS.

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 exitosamente, será redirigido a la pantalla principal de tu aplicación. Este inicio de sesión y redirección del usuario es manejado por el SDK de Catalyst.

Para asegurar que esta redirección se maneje correctamente, incluye la clave dada a continuación con las mismas configuraciones en el archivo info.plist de tu proyecto iOS:

Key - URL Types -----> URL Schemes
Type - String
Value - La URL de redirección que configuraste al crear el paquete para tu aplicación en Catalyst

catalyst_sdk_ios_info_plist

Paso 5: Inicializar el SDK

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

Por lo tanto, antes de configurar tu aplicación para consumir los métodos del SDK, debes inicializar el SDK de la siguiente manera:

copy
public func initSDK( window : UIWindow, environment : ZCatalystEnvironment, appConfiguration : ZCatalystAppConfiguration ) throws

Parámetros:

  • window: El objeto window que despacha eventos a tus vistas
  • environment: El entorno de tu aplicación, ya sea .development o .production.
  • appConfiguration: Un objeto que contiene todos los detalles de configuración para el funcionamiento del SDK.

El environment aquí indica si la aplicación está operando en el entorno de Development o Production. De manera similar a incluir el archivo de configuración plist apropiado según el entorno en el proyecto de tu aplicación, debes inicializar el SDK para el entorno apropiado.

Nota:
  • Si realizas algún cambio en el archivo AppConfigurationDevelopment.plist o AppConfigurationProduction.plist, debes reinicializar el SDK.

  • Si configuras una autenticación de terceros para tu aplicación iOS, también necesitarás reinicializar el SDK ya que se agregarán nuevas propiedades en este archivo de configuración. Puedes aprender más en esta página de ayuda.

Si el SDK se inicializa exitosamente, la aplicación invocará los métodos de los componentes y funcionará como se espera.

Paso 6: Configurar la redirección a la pantalla de la aplicación

Si la página de inicio de sesión configurada en tu aplicación iOS es de un dominio diferente, puedes configurar la redirección a la pantalla de tu aplicación. Al iniciar sesión exitosamente, esto te redirigirá a la capa de la aplicación.

El código para la instancia de UIApplication se muestra a continuación:

copy
ZCatalystApp.shared.handleLoginRedirection( _ url : URL, sourceApplication : String?, annotation : Any )  AppDelegate.swift

Parámetros:

  • url: El recurso URL que debe abrirse después de un inicio de sesión exitoso
  • sourceApplication: El bundle ID de la aplicación que solicita abrir la URL
  • annotation: Datos adicionales que la aplicación quiere enviar junto con la URL

El código para la instancia de UIScene se muestra a continuación:

copy
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    if let context = URLContexts.first
    {
        ZCatalystApp.shared.handleLoginRedirection(context.url, sourceApplication: context.options.sourceApplication, annotation: context.options.annotation as Any)
    }
}

La configuración está completa y ahora puedes construir tu aplicación iOS con el SDK de iOS de Catalyst.

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