Integración de Catalyst Java SDK en aplicaciones de terceros

Puedes integrar y utilizar los métodos de Catalyst Java SDK en aplicaciones desplegadas fuera del entorno de Catalyst. Por ejemplo, una aplicación React alojada en Vercel que usa un backend Flask (ejecutándose fuera de Catalyst) puede subir documentos a Catalyst Cloud Scale Stratus, o un pipeline de datos ejecutándose en Amazon Web Services EC2 puede enviar datos de clientes a Catalyst Cloud Scale Data Store usando consultas de Catalyst Cloud Scale ZCQL mediante las operaciones respectivas de Java SDK.

Estos son solo algunos casos de uso comunes en los que aplicaciones externas pueden interactuar de forma segura con los componentes de Catalyst sin estar desplegadas dentro de la plataforma de Catalyst.

Hemos proporcionado el fragmento de código para ayudarte a integrar Catalyst Java SDK con aplicaciones externas. Sin embargo, antes de implementar el código en tu aplicación, revisa los siguientes requisitos previos.

Requisitos previos para la integración del SDK

Para integrar Catalyst Java SDK con tu aplicación externa, asegúrate de contar con la siguiente información:

• Project ID:

El identificador único de tu proyecto de Catalyst.

• ZAID (Zoho Account ID):

Un identificador único de portal asignado por Catalyst para vincular tu proyecto con el entorno de Catalyst (desarrollo o producción).

• Environment:

El entorno de destino (desarrollo o producción) de tu proyecto de Catalyst.

• Credenciales OAuth:

Esto es necesario para autenticar y autorizar tu aplicación externa a través del portal de self-client de Catalyst para acceder a los componentes de Catalyst. Necesitarás lo siguiente:

1. Client ID
2. Client Secret
3. Refresh Token

Una vez que obtengas estos valores, puedes proceder con la integración de Java SDK en tu aplicación.

Pasos para la integración

Ahora, veamos cómo obtener cada uno de estos valores y configurarlos en el fragmento de código.

Asegúrate de seguir los pasos que se describen a continuación:

1. Crear un proyecto en la consola de Catalyst: Puedes crear un nuevo proyecto de Catalyst en la consola siguiendo los pasos mencionados en esta página de ayuda.

2. Obtener el Project ID: Una vez que hayas creado tu proyecto, deberás tomar nota del Project ID. El Project ID es el identificador único de tu proyecto que se crea automáticamente durante la creación del proyecto.

Puedes encontrarlo haciendo clic en el ícono de Settings ubicado en la esquina superior derecha de la consola de Catalyst.

En la pantalla de Settings, navega a Project Settings y selecciona General. Puedes ver y tomar nota del Project ID en esta sección, como se muestra en la captura de pantalla a continuación.

3. Obtener el ZAID:

Deberás incluir el ZAID de tu proyecto en el fragmento de código proporcionado en esta sección. El ZAID es un identificador único de portal asignado por Catalyst para vincular tu proyecto con el entorno de Catalyst requerido (desarrollo o producción).

Para obtener el ZAID, es obligatorio configurar el componente Catalyst CloudScale Authentication. Sin embargo, su uso para el flujo de autenticación de tu aplicación es opcional. Para obtener el ZAID:

i. Navega al servicio Catalyst CloudScale en la consola y, en Security & Identity, selecciona Authentication.

ii. Deberás configurar Native Catalyst Authentication, donde Catalyst gestiona todo el proceso de autenticación por ti, eliminando la necesidad de programación adicional o gestión de infraestructura de tu parte.

iii. Haz clic en Set Up.

iv. Selecciona el tipo Hosted authentication, que te permite alojar tu elemento de inicio de sesión en páginas dedicadas de tu aplicación. Puedes configurar y diseñar la autenticación desde la consola, y Catalyst la renderizará para tu aplicación y manejará todos los requisitos del backend.

v. Debes habilitar la opción Public Signup para mostrar la funcionalidad de registro en tu componente de inicio de sesión, permitiendo que nuevos usuarios se registren y accedan a tu aplicación. Puedes consultar la página de ayuda de hosted authentication para obtener una guía detallada paso a paso.

vi. En la pantalla de confirmación, haz clic en Yes, proceed.

vii. Puedes habilitar cualquiera de las opciones de inicio de sesión social compatibles que se enumeran a continuación y obtener el valor de ZAID correspondiente del proveedor seleccionado.

4. Registrar una aplicación Self Client: Necesitarás obtener el Refresh Token, Client ID y Client Secret para autenticar y autorizar tu aplicación para acceder a los recursos de Catalyst en nombre del usuario de tu aplicación.

Para obtener los elementos requeridos mencionados anteriormente, primero debes registrar tu aplicación como self-client en la consola de API.

i. Inicia sesión en la consola de API y haz clic en Self-client.

ii. Configura el scope de la aplicación self-client en función de las operaciones que tu aplicación necesita realizar en Catalyst.

Obtén más información sobre los scopes disponibles.

iii. Proporciona el scope requerido, agrega una descripción apropiada y haz clic en Create.

iv. Se generará el grant token. Asegúrate de copiarlo y almacenarlo de forma segura, ya que este es un proceso único y el token no se puede recuperar de la consola nuevamente.

Obtén más información sobre cómo generar un grant token.

v. Cambia a la pestaña Client Secret y toma nota de los detalles del client ID y el client secret.

vi. Puedes generar el access token y el refresh token utilizando la solicitud en esta página de ayuda. También puedes refrescar el access token siguiendo los pasos descritos en esta página.

Una vez que hayas anotado todos los valores mencionados anteriormente, puedes configurarlos en el fragmento de código como se muestra a continuación e integrar Java SDK en tu aplicación. El código de SpringBoot a continuación demuestra esto con el ejemplo de obtener buckets de Catalyst CloudScale Stratus.

Fragmento de código

package com.example.demoapp; 
import org.springframework.boot.CommandLineRunner; 
import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
import org.springframework.stereotype.Component; 
import java.util.List; 
import java.util.logging.Logger; 
import org.json.simple.JSONObject; 
import com.zc.common.ZCProject; 
import com.zc.common.ZCProject; 
import com.zc.common.ZCProjectConfig; 
import com.catalyst.config.ZCThreadLocal; 
import com.zc.api.APIConstants.ZCAuthType; 
import com.zc.api.APIConstants.ZCUserScope; 
import com.zc.auth.ZCAuth; 
import com.zc.component.USER_TYPE; 
import com.zc.component.object.ZCObject; 
import com.zc.component.object.ZCRowObject; 
import com.zc.component.object.ZCTable; 
@SpringBootApplication 
public class DemoappApplication { 
private static final Logger logger = 
Logger.getLogger(DemoappApplication.class.getName()); 
public static void main(String[] args) { 
SpringApplication.run(DemoappApplication.class, args); 
} 
@Component 
public static class DataProcessor implements CommandLineRunner { 
@Override 
public void run(String... args) { 
try { 
ZCThreadLocal.putValue("user_type", USER_TYPE.ADMIN); 
JSONObject oAuthParams = new JSONObject(); 
oAuthParams.put("client_id", CLIENT_ID); //Ingresa aquí el ID de cliente
oAuthParams.put("client_secret", CLIENT_SECRET); //Ingresa aquí el secreto de cliente
oAuthParams.put("refresh_token", REFRESH_TOKEN); //Ingresa aquí el token de actualización
oAuthParams.put("grant_type", "refresh_token");   
ZCAuth auth = ZCAuth.getInstance(oAuthParams); 
auth.setScope(ZCUserScope.ADMIN); 
System.out.println("Auth Object: " + auth); 
ZCProjectConfig config = ZCProjectConfig.newBuilder() 
.setProjectId(PROJECT_ID) //Ingresa aquí el ID del proyecto
.setProjectKey(ZAID) //Ingresa aquí el ZAID
.setZcAuth(auth) 
.setProjectDomain("https://api.catalyst.zoho.com") 
.setEnvironment("Development") //"Development" o "Production"
.build(); 
ZCProject project = ZCProject.initProject(config, ""); 
ZCStratus stratus = ZCStratus.getInstance(project); 
List  buckets = stratus.listBuckets(); 
} 
catch (Exception e) { 
logger.severe("Error during data processing: " + 
e.getMessage()); 
            } 
        } 
    } 
}