Integración del SDK de Python de Catalyst en aplicaciones de terceros

Puedes integrar y usar los métodos del SDK de Python de Catalyst en aplicaciones desplegadas fuera del entorno de Catalyst. Por ejemplo, una aplicación React alojada en Vercel usando 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 del SDK de Python. Estos son solo algunos casos de uso comunes donde las 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 el SDK de Python de Catalyst 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 el SDK de Python de Catalyst con tu aplicación externa, asegúrate de tener la siguiente información:

• Project ID: El identificador único de tu proyecto de Catalyst.
• ZAID (Zoho Account ID): Un identificador de portal único asignado por Catalyst para vincular tu proyecto con el entorno de Catalyst (desarrollo o producción).
• Environment: El entorno objetivo (desarrollo o producción) de tu proyecto de Catalyst.
• OAuth Credentials: 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 Después de obtener estos valores, puedes proceder con la integración del SDK de Python en tu aplicación.
   

Pasos para integrar

Ahora, veamos cómo obtener cada uno de estos valores y configurarlos en el fragmento de código. Asegúrate de seguir los pasos descritos a continuación:

1. Crear un proyecto en la consola de Catalyst: Puedes crear un nuevo proyecto de Catalyst en la consola usando los pasos mencionados en esta página de ayuda.
2. Recuperar el Project ID: Una vez que hayas creado tu proyecto, necesitarás tomar nota del Project ID. El Project ID es el ID único de tu proyecto que se creará automáticamente durante la creación del proyecto. Puedes encontrarlo haciendo clic en el ícono 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 desde esta sección, como se muestra en la captura de pantalla a continuación.
   
3. Recuperar el ZAID: Necesitarás incluir el ZAID de tu proyecto en el fragmento de código proporcionado en esta sección. El ZAID es un identificador de portal único asignado por Catalyst para vincular tu proyecto con el entorno de Catalyst requerido (desarrollo o producción). Aprende más sobre los entornos de Catalyst. Para recuperar el ZAID, es obligatorio configurar el componente Catalyst CloudScale Authentication. Sin embargo, usarlo 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 bajo Security & Identity, selecciona Authentication.
   ii. Necesitarás configurar Native Catalyst Authentication, donde Catalyst gestiona todo el proceso de autenticación por ti, eliminando la necesidad de cualquier codificació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 función 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 una guía de configuración 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 soportadas listadas a continuación y recuperar el valor del ZAID correspondiente del proveedor seleccionado. Aprende cómo obtener el ZAID para un inicio de sesión social específico.

import zcatalyst_sdk 
from zcatalyst_sdk import credentials 
from zcatalyst_sdk import types 
from zcatalyst_sdk.types import ICatalystOptions 
from flask import Flask, Request, make_response, jsonify 
from typing import Dict, Literal 
app = Flask(__name__) 
def list_all_buckets(): 
Cred = { 
        "refresh_token": "YOUR_REFRESH_TOKEN", //Ingresa aquí el token de actualización
        "client_id": "CLIENT_ID", //Ingresa aquí el ID de cliente
        "client_secret": "CLIENT_SECRET", //Ingresa aquí el secreto de cliente
    } 
project_id = PROJECT_ID //Ingresa aquí el ID del proyecto
project_key = ZAID //Ingresa aquí el ZAID
environment = "Development" //"Development" o "Production"
catalyst_credential = credentials.RefreshTokenCredential(Cred) 
catalyst_options = ICatalystOptions( 
project_id=project_id, 
project_key=project_key, 
project_domain="https://api.catalyst.zoho.com", 
environment=environment, 
) 
catalystApp = zcatalyst_sdk.initialize_app( 
credential=catalyst_credential, options=catalyst_options, 
name="TaskSDKPython" 
 ) 
stratus = catalystApp.stratus() 
buckets = stratus.list_buckets() 
print(buckets) 
return jsonify({"message": "Success", "bucket_data": buckets}) 
@app.route("/listbuckets", methods=["GET"]) 
def handle_list_all_buckets(): 
return list_all_buckets() 
if __name__ == "__main__": 
with app.app_context(): 
response = handle_list_all_buckets() 
port = 3006 
printf("Server running on http://localhost:{port}") 
app.run(port=port)