Introducción a Catalyst API
Descripción general
Catalyst API ofrece una amplia gama de funcionalidades que permiten a los desarrolladores de aplicaciones trabajar de forma remota con los componentes de Catalyst en su aplicación. Puedes crear y gestionar tu aplicación de Catalyst utilizando las APIs, así como realizar operaciones remotas en ella, de manera similar a trabajar con la consola web de Catalyst.
Por ejemplo, puedes realizar operaciones como insertar datos en una tabla en Data Store, obtener detalles de una carpeta en File Store o ejecutar una función utilizando las APIs correspondientes.
Catalyst implementa los estándares de REST API y admite solicitudes y respuestas HTTP para acceder a sus recursos. Los recursos de Catalyst se exponen a través de sus URLs de endpoint, y los clientes HTTP pueden acceder a estos endpoints utilizando sus APIs específicas.
Catalyst implementa los siguientes principios básicos de REST API:
- La URL de endpoint de cada instancia de un recurso de Catalyst es única.
- El método HTTP en la solicitud determina la operación que se realizará sobre el recurso.
- La información adicional del payload se pasa como parámetros en la solicitud. Estos contienen los detalles de la operación que se va a realizar.
- Cada solicitud genera una respuesta de Catalyst.
Puedes consultar las secciones de formato de solicitud y formato de respuesta para obtener detalles y ejemplos.
Requisitos previos
Antes de comenzar a trabajar con Catalyst API, debes asegurarte de que se cumplan los siguientes requisitos previos:
- Una cuenta de usuario de Zoho válida: Asegúrate de tener una dirección de correo electrónico y contraseña de inicio de sesión de Zoho válidas. Puedes registrarte para obtener una cuenta de Zoho aquí.
- Un token de autenticación: Debes obtener un access_token de OAuth válido para acceder a Catalyst API.
Las páginas de ayuda en la sección Autenticación OAuth 2.0 te guiarán en el proceso de comprensión y obtención de tokens de autenticación.
Todas las APIs de Catalyst serán accesibles para un usuario de Catalyst con el rol de App Administrator (desarrollador de aplicaciones de Catalyst) después de obtener su access_token. Todos los colaboradores de un proyecto en particular también podrán ejecutar todas las APIs de Catalyst utilizando su access_token.
Sin embargo, solo ciertas operaciones son accesibles para los usuarios con el rol de App User, es decir, los usuarios finales de una aplicación de Catalyst con autenticación de usuario de Catalyst. El usuario final solo puede realizar operaciones relacionadas con el acceso a datos específicos de la aplicación, y no operaciones que modifiquen la aplicación. Cada página de ayuda de la API te proporcionará información sobre los permisos de ejecución definidos para ella.
Nota:
-
Si deseas ejecutar operaciones de Catalyst sin generar tokens de autenticación, puedes utilizar el SDK de Catalyst en su lugar.
-
Actualmente, Catalyst no admite un proceso de autenticación de API separado para usuarios finales de aplicaciones de Catalyst. Si implementas el SDK de Catalyst en el código de tu aplicación, la autenticación se gestiona automáticamente como una autenticación de App Administrator. Para utilizar Catalyst API de forma independiente, debes seguir los pasos descritos en la sección Autenticación OAuth 2.0 para generar tokens de autenticación OAuth.
Soporte Multi-DC
Descripción general
Catalyst está alojado actualmente en siete centros de datos. La URI base de la API para acceder a todas las APIs de Catalyst y la URI del servidor de cuentas de Zoho serán diferentes según el centro de datos desde el que accedas a Catalyst.
Debes utilizar el dominio apropiado según tu ubicación al enviar una solicitud de API en Catalyst. Esto previene conflictos con tu navegador y permite una integración fluida con tu sesión actual.
Los siete centros de datos y sus respectivas URIs base de API compatibles con Catalyst para todas las APIs son:
- US (EE. UU.): https://api.catalyst.zoho.com
- EU (Europa): https://api.catalyst.zoho.eu
- IN (India): https://api.catalyst.zoho.in
- AU (Australia): https://api.catalyst.zoho.com.au
- CA (Canadá): https://api.catalyst.zohocloud.ca
- JP (Japón): https://api.catalyst.zoho.jp
- SA (Arabia Saudita): https://api.catalyst.zoho.sa
Las correspondientes URIs del servidor de cuentas de Zoho para los siete centros de datos que debes utilizar al implementar la autenticación OAuth 2.0 son:
- US: https://accounts.zoho.com
- EU: https://accounts.zoho.eu
- IN: https://accounts.zoho.in
- AU: https://accounts.zoho.au
- CA: https://accounts.zohocloud.ca
- JP: https://accounts.zoho.jp
- SA: https://accounts.zoho.sa
Uso
Debes asegurarte de realizar las siguientes acciones para aprovechar el soporte multi-DC de Catalyst:
- Debes utilizar la URI del servidor de cuentas de Zoho apropiada en todos los pasos al implementar la autenticación OAuth 2.0,
como al realizar una solicitud de autorización para generar el grant token, access token o refresh token.
Por ejemplo, puedes realizar esta solicitud para generar el grant token usando un método de redirección para el centro de datos de la UE:
Se devolverá una respuesta con el grant token después de redirigir a la URI de redirección, la cual contendrá un parámetro de ubicación como se muestra a continuación:
Este parámetro location especifica el dominio de tu cuenta. En este caso, el location se devuelve como eu.
- Puedes habilitar el soporte multi-DC después de registrar tu cliente en la consola de API de Zoho. Esto te permite proporcionar acceso a tu aplicación solo a usuarios de un dominio específico. Por ejemplo, puedes deshabilitar el acceso a tu aplicación para los usuarios de IN y habilitarlo para los demás usuarios. Consulta la sección Registrar un nuevo Client para obtener más detalles.
- Como se mencionó anteriormente, debes utilizar la URI base de API apropiada al enviar una solicitud de API. Por ejemplo, para obtener todas las filas en una tabla de tu Data Store, debes ejecutar la siguiente URL de solicitud para el centro de datos de la UE:
https://api.catalyst.zoho.eu/baas/v1/project/{project_id}/table/{tableIdentifier}/row
Soporte Multi-Org
Descripción general
Catalyst te permite crear y gestionar múltiples organizaciones dentro de tu cuenta de Catalyst. Se generará un Org ID único para cada organización que crees. Puedes crear proyectos individuales en cada organización y también asignar permisos de acceso a las personas que contribuyen al proyecto.
Solo puedes tener una organización en tu cuenta como predeterminada. La organización marcada como predeterminada se iniciará sesión automáticamente cada vez que accedas a tu cuenta de Catalyst.
Cuando ejecutas una API desde Catalyst, se ejecutará automáticamente para la organización predeterminada. Por ejemplo, cuando pasas el ID del proyecto en tu solicitud de API, Catalyst buscará automáticamente un proyecto con el mismo ID en tu organización predeterminada. Sin embargo, puedes ejecutar una API para otras organizaciones que no sean la predeterminada pasando exclusivamente el Org ID único de esas organizaciones en tus solicitudes.
Uso
Puedes pasar el Org ID como encabezado en una solicitud de API para acceder a un proyecto en esa organización con este formato:
-H CATALYST-ORG: 15090237
Puedes consultar una solicitud de ejemplo completa en la sección Formato de solicitud.
Formato de solicitud
Métodos de solicitud
Catalyst API sigue los estándares REST y admite los siguientes métodos HTTP para las solicitudes del cliente con los propósitos descritos:
- GET : Para obtener registros de un recurso de Catalyst
- POST : Para insertar nuevos registros en un recurso de Catalyst
- PUT : Para actualizar registros existentes en un recurso de Catalyst
- DELETE : Para eliminar registros existentes en un recurso de Catalyst
Debes especificar el método de solicitud para la operación al ejecutar una solicitud de Catalyst API.
URL de solicitud
Las solicitudes de la API se envían en formato CURL. Una URL de solicitud típica tiene el siguiente formato:
https://api.catalyst.zoho.com/baas/v1/project/{project_id}
/{resource_name}/{additional_resource_details}
Nota: La URL base de la API será la siguiente para los otros centros de datos:
- EU: https://api.catalyst.zoho.eu
- IN: https://api.catalyst.zoho.in
- AU: https://api.catalyst.zoho.com.au
- CA: https://api.catalyst.zohocloud.ca
- JP: https://api.catalyst.zoho.jp
- SA: https://api.catalyst.zoho.sa
Los parámetros comunes que se pasan en la URL de solicitud incluyen el Project ID del proyecto de Catalyst y el ID del recurso de la instancia específica del recurso al que se accede.
Encabezados de solicitud
El encabezado obligatorio que se pasa en la solicitud cURL incluye lo siguiente:
- Encabezado de autorización: Token OAuth, es decir, el access_token
Los encabezados recomendados que se pasan en la solicitud cURL pueden incluir los siguientes:
- Content-Type: Un estándar de REST API que indica el tipo de medio original del recurso pasado. Se recomienda encarecidamente pasar este encabezado cuando las solicitudes de la API incluyen payload en formato JSON o datos de formulario, por ejemplo.
Los encabezados opcionales que se pasan en la solicitud cURL pueden incluir los siguientes:
- Org ID: El Org ID de una organización que no es la predeterminada. Puedes obtener el Org ID desde el portal multi-org en la consola de Catalyst.
- Environment: El encabezado de entorno para especificar el entorno para el que debe ejecutarse la solicitud. Puedes indicar si la solicitud de la API debe ejecutarse para el entorno de desarrollo o producción del proyecto.
Cuerpo de solicitud
Según el propósito de la solicitud, puedes pasar datos adicionales en el cuerpo de la solicitud en una llamada a la API, como el nombre de la columna y el valor para actualizar la columna de una tabla, o el nombre de la carpeta para crear una carpeta.
Los detalles de la solicitud que se debe enviar, como los encabezados y los atributos JSON que se deben pasar en la solicitud, se especifican en cada página de ayuda de la API para la solicitud específica.
curl “https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/4000000006023/cache"
-X POST
-d ‘{“cache_name”:“City”,“cache_value”:“London”}’
-H “CATALYST-ORG: 15090237”
-H “Environment:Development”
-H “Content-Type:application/json”
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57"”
Formato de respuesta
Descripción general
Todas las respuestas de Catalyst API estarán en formato JSON. La respuesta se envía después de que el servidor de Catalyst procesa una solicitud.
Una respuesta típica contiene el estado del procesamiento de la solicitud, que puede ser success o failure, y un conjunto de datos basado en la solicitud realizada. Por ejemplo, si la solicitud se realizó para eliminar un registro en un recurso, los datos contendrán los detalles del registro que fue eliminado. Los detalles de la respuesta de cada API se especifican en detalle en su página de ayuda.
Si la solicitud no se procesó correctamente, la respuesta contendrá un código de error apropiado para especificar el error que ocurrió. La siguiente sección contiene los códigos de error reconocidos por Catalyst y sus descripciones.
{
"status": "success",
"data": {
"cache_name": "City",
"cache_value": "London",
"project_details": {
"id": 56000000087108,
"project_name": "ShipmentTracking"
},
"segment_details": {
"id": 56000000112489,
"segment_name": "CustomerLocation"
},
"expires_in": "Mar 28, 2019 02:03 AM",
"expiry_in_hours": 7
}
}
Códigos de error
Cuando el servidor encuentra un error al procesar una solicitud del cliente, envía un código de estado HTTP apropiado en la respuesta al cliente. Los siguientes errores son reconocidos por Catalyst:
| Código de estado HTTP | Código de error | Descripción |
|---|---|---|
| 403 | API_LIMIT_REACHED | Has alcanzado el límite superior de llamadas a la API en tu cuenta. Actualiza tu plan de licencia. |
| 409 | CONFLICT | Existe un conflicto con el valor existente. Intenta proporcionar otro valor. |
| 409 | DUPLICATE_ENTRY | El ID de correo electrónico que ingresaste ya existe. Proporciona un ID de correo electrónico diferente. |
| 409 | DUPLICATE_ENTRY | El nombre de dominio ya existe. Proporciona un valor diferente. |
| 409 | DUPLICATE_OPERATION | La operación solicitada ya está en progreso. Espera hasta que se complete. |
| 409 | DUPLICATE_VALUE | El valor que ingresaste ya existe. Proporciona un valor diferente. |
| 500 | EMAIL_ERROR | El proceso de envío de correo electrónico falló. Inténtalo de nuevo después de un momento. |
| 410 | EXPIRED | El recurso solicitado ha expirado. Intenta crearlo de nuevo. |
| 410 | EXPIRED_LOG | El log de respuesta que intentas descargar ha expirado. |
| 202 | FUNCTION_ERROR | Se encontró un error interno del servidor. |
| 500 | INTERNAL_SERVER_ERROR | Se encontró un error interno del servidor. |
| 403 | INVALID_CONTENT | La entrada proporcionada no tiene un formato aceptable. |
| 404 | INVALID_ID | El ID de recurso que proporcionaste no existe. |
| 400 | INVALID_INPUT | El nombre de tabla que proporcionaste no existe. |
| 400 | INVALID_INPUT | El nombre de columna que proporcionaste no existe. |
| 400 | INVALID_INPUT | La clave foránea que proporcionaste no coincide con el ROWID de la tabla principal. |
| 400 | INVALID_INPUT | La entrada que proporcionaste no es válida. |
| 404 | INVALID_NAME | El ID de correo electrónico que proporcionaste no existe. |
| 404 | INVALID_NAME | El nombre de tabla que proporcionaste no existe. |
| 403 | INVALID_OPERATION | La operación solicitada no es válida. |
| 405 | INVALID_REQUEST_METHOD | El método solicitado no es aceptado. |
| 400 | MISMATCH | El valor proporcionado no coincide con el esperado. |
| 400 | MISSING_FUNCTION | El ID de función que proporcionaste no existe. |
| 400 | MISSING_VALUE | Falta la entrada esperada. |
| 401 | NO_ACCESS | No tienes privilegios para realizar esta acción. |
| 204 | NO_CONTENT_AVAILABLE | La solicitud devolvió una respuesta vacía. |
| 401 | UNAUTHORISED | No estás autorizado para realizar esta acción. |
| 403 | VERIFICATION_NEEDED | Tu dirección de correo electrónico necesita ser verificada. |
| 400 | ZCQL_QUERY_ERROR | El formato de tu consulta no es válido. |
| 429 | TOO_MANY_REQUESTS | Se alcanzaron los límites de concurrencia para la ejecución de funciones, cliente web o un componente de Catalyst. |
Autenticación OAuth 2.0
Descripción general
OAuth 2.0 es un protocolo estándar de la industria para autenticación y autorización. El framework permite que una serie de aplicaciones cliente de terceros obtengan acceso seguro y delegado a recursos protegidos en Zoho a través de APIs.
Algunas características comunes de OAuth 2.0 son:
- Los clientes no necesitan admitir la autenticación por contraseña ni almacenar credenciales de usuario. Se pueden realizar llamadas a la API para acceder a recursos sin tener que proporcionar credenciales de usuario en cada llamada.
- Los clientes solo tendrán acceso a los recursos autenticados por el usuario.
- Los usuarios pueden revocar el acceso delegado del cliente en cualquier momento.
- Los access tokens de OAuth 2.0 expiran después de un tiempo establecido, lo que proporciona una seguridad sólida.
Terminología
Antes de aprender sobre los pasos involucrados en la implementación de OAuth 2.0, debes comprender los siguientes términos relacionados con OAuth 2.0 en el contexto de Catalyst:
| Términos clave | Descripción |
|---|---|
| Protected Resource | Un recurso de Catalyst como Cache, Cron, Table o Folder |
| Resource Server | El servidor de Catalyst que aloja los recursos protegidos de Catalyst |
| Client | Una aplicación que envía solicitudes al servidor de recursos para acceder a los recursos protegidos en nombre del usuario final |
| client_id | La clave única generada para un cliente registrado |
| client_secret | El valor secreto generado para el client_id de un cliente registrado específico. Cuando registras tu aplicación de Catalyst en la consola de API de Zoho, se generarán un client_id y un client_secret para ella. |
| Authentication Server | El servidor de autorización de Catalyst que proporciona las credenciales necesarias a un cliente, como el access_token o el refresh_token |
| Grant Token o code | El servidor de autorización de Catalyst genera un token temporal y lo envía al cliente a través del navegador. El cliente enviará este código de vuelta al servidor de autorización para obtener los access y refresh tokens. |
| access_token | Un token temporal que se envía al servidor de recursos para acceder a los recursos protegidos del usuario. Los clientes usan el access_token para realizar solicitudes a la aplicación asociada usando las APIs. Cada access_token será válido por un período de tiempo establecido y solo se puede usar para realizar las operaciones descritas en el scope. |
| refresh_token | Un token que se puede usar para obtener nuevos access tokens. Este token tiene una duración ilimitada hasta que sea revocado por el usuario final. |
| Scopes | Los scopes controlan el tipo de recursos a los que la aplicación cliente puede acceder. Cada token generalmente se crea con scopes seleccionados para una mejor seguridad. Por ejemplo, puedes generar un access_token con un scope para solo leer los datos en Data Store o File Store. El formato estándar para definir un scope es scope=service_name.scope_name.operation_type. La siguiente sección lista los scopes disponibles en Catalyst. |
Lista de Scopes disponibles en Catalyst
| Nombre del Scope | Scopes disponibles |
|---|---|
| projects | ZohoCatalyst.projects.ALL, ZohoCatalyst.project.export.READ, ZohoCatalyst.project.export.CREATE, ZohoCatalyst.project.import.READ, ZohoCatalyst.project.import.CREATE, ZohoCatalyst.project.import.DELETE |
| authentication | ZohoCatalyst.authentication.CREATE |
| tables | ZohoCatalyst.tables.READ, ZohoCatalyst.tables.rows.READ, ZohoCatalyst.tables.rows.CREATE, ZohoCatalyst.tables.rows.UPDATE, ZohoCatalyst.tables.rows.DELETE, ZohoCatalyst.tables.columns.READ |
| folders | ZohoCatalyst.folders.ALL |
| files | ZohoCatalyst.files.CREATE, ZohoCatalyst.files.READ, ZohoCatalyst.files.DELETE |
| cache | ZohoCatalyst.segments.ALL, ZohoCatalyst.cache.READ, ZohoCatalyst.cache.CREATE, ZohoCatalyst.cache.DELETE |
| cron | ZohoCatalyst.cron.ALL |
| zcql | ZohoCatalyst.zcql.CREATE |
| functions | ZohoCatalyst.functions.ALL, ZohoCatalyst.circuits.execution.EXECUTE |
| appsail | ZohoCatalyst.appsail.Read, ZohoCatalyst.appsail.Create, ZohoCatalyst.appsail.Update, ZohoCatalyst.appsail.Delete |
| circuits | ZohoCatalyst.circuits.EXECUTE |
| search | ZohoCatalyst.search.READ |
| ZohoCatalyst.email.CREATE | |
| notifications | ZohoCatalyst.notifications.web, ZohoCatalyst.notifications.mobile |
| mlkit | ZohoCatalyst.mlkit.READ |
| quickml | QuickML.deployment.READ |
| smartbrowz | ZohoCatalyst.pdfshot.execute, ZohoCatalyst.dataverse.execute |
| pipelines | ZohoCatalyst.pipeline.READ, ZohoCatalyst.pipeline.execution.CREATE |
| stratus | Stratus.fileop.CREATE, Stratus.fileop.ALL, Stratus.bucketop.ALL, ZohoCatalyst.buckets.objects.UPDATE, ZohoCatalyst.buckets.objects.READ, ZohoCatalyst.buckets.objects.DELETE, ZohoCatalyst.buckets.READ, ZohoCatalyst.buckets.objects.CREATE |
| IAM | AaaServer.profile.READ |
| tunneling | ZohoCatalyst.tunneling.READ, ZohoCatalyst.tunneling.UPDATE |
| scheduling | ZohoCatalyst.jobpool.READ, ZohoCatalyst.job.ALL |
| logs | ZohoCatalyst.cli.logs.CREATE |
| security_rules | ZohoCatalyst.security.rules.Read, ZohoCatalyst.security.rules.Update |
| event_listeners | ZohoCatalyst.eventlistners.ALL, ZohoCatalyst.eventlisteners.produce |
| NoSQL | ZohoCatalyst.nosql.READ, ZohoCatalyst.nosql.rows.ALL |
| users | ZohoCatalyst.projects.users.READ, ZohoCatalyst.projects.users.CREATE, ZohoCatalyst.projects.users.DELETE, ZohoCatalyst.projects.users.UPDATE |
| webapp | ZohoCatalyst.webapp.ALL |
| queue | ZohoCatalyst.queue.ALL, ZohoCatalyst.queue.data.READ, ZohoCatalyst.queue.data.CREATE |
| api gateway | ZohoCatalyst.apigateway.apis.READ, ZohoCatalyst.apigateway.apis.CREATE, ZohoCatalyst.apigateway.apis.UPDATE, ZohoCatalyst.apigateway.apis.DELETE, ZohoCatalyst.apigateway.READ, ZohoCatalyst.apigateway.UPDATE |
Paso 1: Registrar un nuevo Client
Registrar el Client
El primer paso para obtener un token de autenticación OAuth es registrar tu aplicación en la consola de API de Zoho y obtener tu client_id y client_secret.
- Para registrar tu aplicación, visita la consola de API de Zoho y haz clic en Get Started.
- Selecciona un tipo de cliente para tu aplicación.
Puedes consultar la documentación OAuth de Zoho para obtener más detalles.
- Proporciona los detalles requeridos para registrar tu aplicación para el tipo de cliente que elegiste.
- Client Name: El nombre de tu aplicación que deseas registrar en Zoho
- Homepage URL: La URL de la página principal de tu cliente
- Authorized Redirect URIs: Una URL válida de tu aplicación a la que Zoho Accounts te redirigirá con el grant token después de una autenticación exitosa
- Haz clic en Create.
Después de que el registro sea exitoso, Zoho te proporcionará un conjunto de credenciales OAuth 2.0: el client_id y el client_secret, que son conocidos tanto por Zoho como por tu aplicación.
Habilitar Multi DC para el Client
Como se menciona en la sección Soporte Multi-DC, puedes habilitar el soporte multi-DC para tu cliente desde la pestaña Settings en la consola de API después de registrarlo. Esto está disponible para todos los tipos de cliente, excepto el tipo Self Client ya que se usa solo para pruebas.
Esta funcionalidad te permite proporcionar acceso a tu aplicación solo a usuarios de un dominio específico. Como se mencionó anteriormente, Catalyst está disponible actualmente en los dominios EU, AU, IN, JP, SA y CA. Así que puedes habilitar o deshabilitar el acceso a tu aplicación para usuarios de centros de datos específicos si lo necesitas.
Para acceder a las configuraciones multi-DC de tu cliente:
- Abre tu cliente desde la consola de API y haz clic en Settings.
- Habilita o deshabilita el acceso del cliente para los centros de datos que necesites. Solo puedes usar los centros de datos que Catalyst admite.
Cuando habilitas un DC, la consola generará un client_secret diferente para ellos de forma predeterminada. Puedes acceder a él haciendo clic en Show Code para el DC respectivo. El client_id permanecerá igual para todos los DCs.
Puedes elegir tener el mismo client_secret para todos los DCs marcando la casilla de verificación Use the same OAuth credentials for all data centers. Luego debes hacer clic en OK en la ventana emergente de confirmación.
Puedes desmarcar nuevamente la casilla de verificación para tener un client_secret diferente, y confirmar la acción de manera similar.
Paso 2: Generar Grant Token
Después de generar el client_id y el client_secret, debes generar un Grant Token o code para tu aplicación.
Para aplicaciones Self Client
Si previamente seleccionaste el tipo Self Client, debes generar el Grant Token (code) de la siguiente manera:
- Después de registrar tu aplicación, selecciona Self Client de la lista de Applications en la
consola de API y haz clic en Generate Code.
- Ingresa un scope válido. Puedes consultar la lista de scopes disponibles en Catalyst en esta sección.
- Elige una duración de tiempo en la lista desplegable. El Grant Token generado en este paso expirará después de este período de tiempo.
- Ingresa una descripción para el scope.
- Haz clic en Generate.
La consola de API mostrará el Grant Token generado o el valor de code para tu aplicación Self Client.
Para otras aplicaciones
Si previamente seleccionaste tipos de cliente diferentes al tipo Self Client, debes generar el Grant Token usando un método de redirección:
- Envía una solicitud a la siguiente URI con los parámetros indicados a continuación, para generar el Grant Token (code):
https://accounts.zoho.com/oauth/v2/auth?
Nota: Debes acceder a los dominios respectivos para los otros centros de datos:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
| Parámetro | Descripción |
|---|---|
| scope* | El scope para el cual se generará el Grant Token. Puedes proporcionar múltiples scopes separándolos con comas. Puedes consultar la lista de scopes disponibles en Catalyst en [esta sección](/es/api/oauth2/scopes/#Scopes). |
| client_id* | El Client ID que se generó durante el registro del cliente |
| state | Una cadena opaca que se transmite de ida y vuelta en el protocolo, es decir, cualquier valor que proporciones aquí se te devolverá |
| response_type* | code(Proporciona esta cadena literal como valor) |
| redirect_uri* | Una de las URIs de redirección autorizadas que proporcionaste al registrar el cliente en el paso anterior. No debes proporcionar una URI de redirección no registrada. |
| access_type | Los valores permitidos son offline y online. El access_type online solo proporciona el Access Token para tu aplicación, que es válido por una hora. El access_type offline proporciona un Access Token así como un Refresh Token para tu aplicación. El valor predeterminado se considera online. |
| prompt | Consent (Proporciona esta cadena literal como valor) Solicita el consentimiento del usuario cada vez que tu aplicación intenta acceder a las credenciales del usuario. Si no especificas este parámetro, solo se le solicitarán las credenciales al usuario la primera vez que tu aplicación solicite acceso. |
Nota:
-
Los campos marcados con * son obligatorios.
-
Puedes pasar los parámetros en el cuerpo de tu solicitud como form-data, para mayor seguridad.
Ejemplo de solicitud
- Si envías el parámetro prompt en esta solicitud, se abrirá una página de consentimiento del usuario.
Después de hacer clic en Accept, Zoho te redirigirá a la redirect_uri con el Grant Token en el parámetro code. Guarda el valor de code para los siguientes pasos.
Según los detalles de tu inicio de sesión, el sistema detecta automáticamente tu dominio y utiliza la URL de autenticación específica del dominio para generar el Grant Token. El parámetro state también se pasa en la URL.
Si haces clic en Reject, el navegador redirige a la URI de redirección con el parámetro error=access_denied.
Paso 3: Generar Access Token y Refresh Token
Ejecución de la solicitud
Después de obtener el Grant Token, envía una solicitud POST a la siguiente URL con los parámetros indicados a continuación para generar el access_token:
https://accounts.zoho.com/oauth/v2/token?
Nota: Debes acceder a los dominios respectivos para los otros centros de datos:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
| Parámetro | Descripción |
|---|---|
| code* | El Grant Token o el valor de code obtenido en el paso anterior. |
| client_id* | El Client ID que se generó durante el registro del cliente |
| client_secret* | El Client Secret que se generó durante el registro del cliente |
| grant_type* | authorization_code (Proporciona esta cadena literal como valor) |
| redirect_uri | Una de las URIs de redirección autorizadas que proporcionaste al registrar el cliente en el paso anterior. No debes proporcionar una URI de redirección no registrada. |
| scope |
El scope para el cual se generará el access_token. Puedes proporcionar múltiples scopes separándolos con comas. Puedes consultar la lista de scopes disponibles en Catalyst en [esta sección](/es/api/oauth2/scopes/). |
| state | Una cadena opaca que se transmite de ida y vuelta en el protocolo. En otras palabras, cualquier valor que proporciones aquí se te devolverá. |
Nota:
- Los campos marcados con * son obligatorios.
- Puedes pasar los parámetros en el cuerpo de tu solicitud como form-data, para mayor seguridad.
- El access_token expirará después del período de tiempo (en segundos) mencionado en el parámetro expires_in.
- Sin embargo, el refresh_token es permanente y se puede usar para regenerar un nuevo access_token si el actual expira.
- Puedes usar el dominio especificado en api_domain en tus solicitudes para hacer llamadas a la API de Catalyst.
- El valor “Bearer” en token_type indica que se trata de un access_token.
Esto completa el proceso de autenticación. Una vez que obtengas el access_token para tu aplicación, puedes usarlo en el encabezado de autorización de tus solicitudes HTTP para acceder a las APIs de Catalyst. Puedes consultar la sección Formato de solicitud para ver un ejemplo.
{
"access_token": "{access_token}",
"refresh_token": "{refresh_token}",
"api_domain": "https://www.zohoapis.com",
"token_type": "Bearer",
"expires_in": 3600
}
Paso 4: Renovar Access Token
Ejecución de la solicitud
Cuando un access_token expira, debes usar el refresh_token para generar un nuevo access_token para tu aplicación.
Para hacerlo, envía una solicitud POST a la siguiente URL con los parámetros indicados a continuación:
https://accounts.zoho.com/oauth/v2/token?
Nota: Debes acceder a los dominios respectivos para los otros centros de datos:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
| Parámetro | Descripción |
|---|---|
| refresh_token* | El refresh_token obtenido en el paso anterior |
| client_id* | El Client ID que se generó durante el registro del cliente |
| client_secret* | El Client Secret que se generó durante el registro del cliente |
| grant_type* | refresh_token (Proporciona esta cadena literal como valor) |
| redirect_uri* | Una de las URIs de redirección autorizadas que proporcionaste al registrar el cliente en el paso anterior. No debes proporcionar una URI de redirección no registrada. |
{
"access_token": "{new_access_token}",
"expires_in": 3600,
"api_domain": "https://www.zohoapis.com",
"token_type": "Bearer"
}
Proyectos de Catalyst
Las APIs de proyectos te permiten crear, actualizar, eliminar y obtener detalles de un proyecto de Catalyst. También puedes realizar estas acciones desde la consola de Catalyst. Catalyst CLI también te permite crear un proyecto de forma remota e inicializar recursos en él.
Crear un nuevo proyecto
Descripción
Esta API te permite crear un nuevo proyecto de Catalyst en tu cuenta de Catalyst. Debes pasar el nombre de proyecto requerido en la solicitud.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZOHOCATALYST.projects.CREATE
Propiedades JSON de la solicitud
Tamaño máximo: 50 caracteres
Detalles de la respuesta
La respuesta contendrá los detalles del proyecto que se creó incluyendo los detalles del dominio del proyecto como el project_domain_id y project_domain_name, y los detalles del usuario como su email_id y user_id.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“project_name”:“BillingDesk”
}’
{
"status": "success",
"data": {
"project_name": "BillingDesk",
"created_by": {
"zuid": 3000000006001,
"is_confirmed": true,
"email_id": "amelia.burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930455
},
"created_time": "Jan 29, 2020 11:59 AM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10018095112,
"project_domain_name": "billingdesk-697215025.development",
"project_domain": "billingdesk-697215025.development.zohocatalyst.com",
"user_auth": {},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 3000000005090,
"project_type": "Live",
"timezone": "Asia/Kolkata"
}
}
Paso 5: Revocar Refresh Token
Ejecución de la solicitud
Puedes optar por revocar manualmente un refresh_token cuando ya no necesites acceso para un scope en particular.
Para revocar un refresh_token, envía una solicitud POST a la siguiente URL con el refresh_token que deseas revocar como parámetro.
https://accounts.zoho.com/oauth/v2/token/revoke?
Nota: Debes acceder a los dominios respectivos para los otros centros de datos:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
Tu refresh token ahora quedará invalidado.
Obtener los detalles de un proyecto específico
Descripción
Esta API te permite obtener los detalles de un proyecto específico que el usuario de Catalyst, como el desarrollador o un colaborador, que ha iniciado sesión actualmente ha creado desde su cuenta de Catalyst. El proyecto se referencia por su project_id. Los detalles del proyecto obtenidos son de la misma cuenta de Catalyst desde la que se está ejecutando la API.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
scope=ZOHOCATALYST.projects.Read
Detalles de la respuesta
La respuesta contendrá los detalles del proyecto incluyendo los detalles del dominio del proyecto como el project_domain_id y project_domain_name, y los detalles del usuario que lo creó, como su email_id y user_id.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"platforms": [],
"project_name": "BillingDesk",
"created_by": {
"zuid": 780776954,
"is_confirmed": false,
"email_id": "amelia-burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 11811000000003003
},
"created_time": "Jun 04, 2023 04:19 PM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10060895541,
"project_domain_name": "billingdesk-781316834.development",
"project_domain": "https://billingdesk-781316834.development.catalystserverless.com",
"user_auth": {
"userAuth": {},
"createdTime": null,
"createdBy": null
},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 11811000000315013,
"project_type": "Live",
"env_details": [
{
"id": 11811000000315049,
"env_name": "Development",
"env_type": 3,
"env_status": "Active",
"project_details": {
"project_name": "BillingDesk",
"id": 11811000000315013,
"project_type": "Live"
},
"is_default": true,
"env_zgid": "781316834",
"action_required": false
}
],
"timezone": "Asia/Kolkata"
}
}
Obtener los detalles de todos los proyectos
Descripción
Esta API te permite obtener los detalles de todos los proyectos en la consola remota del usuario de Catalyst, como el desarrollador o un colaborador, que ha iniciado sesión actualmente. Los detalles de los proyectos obtenidos son de la misma cuenta de Catalyst desde la que se está ejecutando la API.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZOHOCATALYST.projects.Read
Detalles de la respuesta
La respuesta contendrá los detalles de todos los proyectos que el usuario creó en su consola remota, incluyendo los detalles del dominio del proyecto como el project_domain_id y project_domain_name, y los detalles del usuario que lo creó, como su email_id y user_id de cada proyecto.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"platforms": [],
"project_name": "BillingDesk",
"created_by": {
"zuid": 780776954,
"is_confirmed": false,
"email_id": "amelia.burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 11811000000003003
},
"created_time": "Jun 04, 2023 04:19 PM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10060895541,
"project_domain_name": "billingdesk-781316834.development",
"project_domain": "https://billingdesk-781316834.development.catalystserverless.com",
"user_auth": {
"userAuth": {},
"createdTime": null,
"createdBy": null
},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 11811000000315013,
"project_type": "Live",
"env_details": [
{
"id": 11811000000315049,
"env_name": "Development",
"env_type": 3,
"env_status": "Active",
"project_details": {
"project_name": "BillingDesk",
"id": 11811000000315013,
"project_type": "Live"
},
"is_default": true,
"env_zgid": "781316834",
"action_required": false
}
],
"timezone": "Asia/Kolkata"
},
{
"platforms": [],
"project_name": "Zia",
"created_by": {
"zuid": 780776954,
"is_confirmed": false,
"email_id": "amelia.burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 11811000000003003
},
"created_time": "Jun 02, 2023 11:55 AM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10060816047,
"project_domain_name": "zia-781316834.development",
"project_domain": "https://zia-781316834.development.catalystserverless.com",
"user_auth": {
"userAuth": {},
"createdTime": null,
"createdBy": null
},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 11811000000314001,
"project_type": "Live",
"env_details": [
{
"id": 11811000000314037,
"env_name": "Development",
"env_type": 3,
"env_status": "Active",
"project_details": {
"project_name": "Zia",
"id": 11811000000314001,
"project_type": "Live"
},
"is_default": true,
"env_zgid": "781316834",
"action_required": false
}
],
"timezone": "Asia/Kolkata"
}
Eliminar proyecto
Descripción
Esta API te permite eliminar un proyecto particular, referenciándolo por su Project ID.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZOHOCATALYST.projects.Delete
Propiedades JSON de la solicitud
Tamaño máximo: 50 caracteres
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json” \
{
"status": "success",
"data": {
"id": 4000000006007
}
}
Functions
Catalyst Functions te permite construir funcionalidades personalizadas en tu aplicación e integrarla sin problemas con otros componentes de Catalyst para proporcionar un backend potente. Puedes automatizar tareas, realizar cálculos intensivos en memoria o integrar con servicios de terceros usando funciones.
Catalyst ofrece soporte para desarrollar funciones del lado del servidor en entornos de programación Java, Node.js y Python.
Ejecutar una función
Descripción
Esta API te permite ejecutar una función Basic I/O haciendo referencia a su ID de función único. Las funciones Basic I/O se utilizan para realizar operaciones básicas de entrada y salida, cálculos y operaciones HTTP simples.
Los parámetros de entrada pueden pasarse a la función en la solicitud de la API ya sea como cadena de consulta o en el cuerpo de la solicitud. Se prefiere una cadena de consulta sobre el cuerpo de la solicitud para pasar los parámetros de la función. La respuesta contendrá la salida de la función.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/function/{function_id}/execute
Métodos de solicitud
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.functions.EXECUTE
Detalles de la respuesta
La respuesta contiene la salida de la función procesada. Una función Basic I/O devuelve la respuesta en formato JSON. La clave output contiene la salida generada por la función que ejecutas.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/function/4000000045004/execute?name=Raymond%20McGregor
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"output": "Hello Raymond McGregor"
}
Circuits
Catalyst Circuits te permiten definir y organizar sistemáticamente una secuencia de tareas que se llevarán a cabo automáticamente en Catalyst. Puedes orquestar tareas y automatizar flujos de trabajo, y adicionalmente incluir condiciones, datos y rutas en el flujo de trabajo, para definir un patrón repetible de actividades que logre un resultado de negocio usando Circuits.
Catalyst ofrece soporte para automatizar la ejecución de funciones Basic I/O de tu aplicación usando un circuit.
Ejecutar un Circuit
Descripción
Esta API te permite ejecutar un circuit de Catalyst configurado en la consola referenciándolo por su Circuit ID único. Puedes pasar la entrada al circuit en el JSON de la solicitud como se describe a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/circuit/{circuit_id}/execute
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.circuits.EXECUTE
Formato JSON de la solicitud
Debes enviar la entrada al circuit como pares clave-valor en formato JSON de esta manera:
{
“key_1”: “value_1”,
“key_2”: “value_2”,
“key_3”: “value_3”,
.
.
}
Detalles de la respuesta
La respuesta contiene el resultado y los detalles del circuit ejecutado, como el circuit_name, el start_time y end_time de la ejecución, el instance_id, junto con los detalles de la entrada que se pasó al circuit y la salida generada por la ejecución del circuit.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/circuit/105000000180234/execute
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-d ‘[
{
“email”:“j.parker@zylker.com”,
“count”:“20”,
“traveller_type”:“Single”,
“rating”:“5”,
“location”:“New York”,
“suite”:“Executive”
}
]’
{
"status": "success",
"data": {
"id": "b3c91799-5c18-4626-9983-a2d6af237e20",
"name": "Case 1",
"start_time": "Aug 24, 2020 02:24 PM",
"end_time": "Aug 24, 2020 02:24 PM",
"status": "success",
"status_code": 6,
"execution_meta": {},
"circuit_details": {
"name": "StayFinder",
"ref_name": "StayFinder",
"description": "",
"instance_id": "ef9644a5-123a-438c-94d9-01b1bade8817"
},
"input": {
"email":"j.parker@zylker.com",
"count":"20",
"traveller_type":"Single",
"rating":"5",
"location":"New York",
"suite":"Executive"
},
"output": {
"result": {
"stay_list":{
"message":"Email has been sent successfully to j.parker@zylker.com",
"status":"success"
}
}
}
}
}
Authentication
Las funcionalidades de Catalyst Authentication te permiten agregar usuarios finales a tus aplicaciones serverless de Catalyst, configurar sus cuentas de usuario y roles, y gestionar el inicio de sesión y la autenticación de usuarios de tu aplicación.
Agregar un nuevo usuario
Descripción
Esta API te permite agregar un nuevo usuario final a la aplicación de Catalyst para una plataforma específica. Cuando el usuario se ha registrado, se crean valores de identificación únicos como ZUID, userID para él.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user/signup
Encabezados de la solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.projects.users.CREATE
Propiedades JSON de la solicitud
Tamaño máximo: 200
El JSON que contiene los detalles del usuario
Tamaño máximo: 100
Tamaño máximo: 100
Detalles de la respuesta
La respuesta contendrá los detalles del usuario agregado en la clave data, incluyendo los metadatos y valores de identificación como zaid, user_id y org_id que fueron generados.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/signup
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-H “PROJECT_ID: 1010309726”
-d ‘{
“user_details”:{
“first_name”:“Rowena”,
“last_name”:“Simmons”,
“email_id”:“r.simmons@zylker.com”
},
“platform_type”:“web”,
“redirect_url”:“https://logistics.zylker.com/app/index.html"
}’
{
"status": "success",
"data": {
"zaid": 1010309726,
"user_details": {
"user_id": 671930455,
"user_type": "App Administrator",
"zuid": 3000000006001,
"zaaid": 1011520995,
"status": "ACTIVE",
"is_confirmed": true,
"email_id": "r.simmons@zylker.com",
"first_name": "Rowena",
"last_name": "Simmons",
"created_time": "May 13, 2019 09:16 PM",
"modified_time": "May 13, 2019 09:16 PM",
"invited_time": "May 13, 2019 09:16 PM",
"role_details": {
"role_id": 1256000000288012,
"role_name": "App Administrator"
}
},
"redirect_url": "https://logistics.zylker.com/app/index.html",
"platform_type": "web",
"org_id": 1011520995
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
Agregar un nuevo usuario a una organización existente
Descripción
Esta API te permite agregar un nuevo usuario final a una organización existente sin crear una nueva organización para él. Esto se puede hacer proporcionando el ZAAID de la organización a la que se debe agregar al usuario. La organización de un usuario no se puede cambiar posteriormente, una vez que se asocia con su cuenta.
Cuando el usuario se ha registrado, se crean valores de identificación únicos como ZUID y User ID para él.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user
Encabezados de la solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.projects.users.CREATE
Propiedades JSON de la solicitud
Tamaño máximo: 200
El JSON que contiene los detalles del usuario
Tamaño máximo: 100
Tamaño máximo: 100
Detalles de la respuesta
La respuesta contendrá los detalles del usuario agregado en la clave data, incluyendo los metadatos y valores de identificación como zaid, user_id y org_id que fueron generados.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“user_details”:{
“first_name”:“John”,
“last_name”:“Winchester”,
“email_id”:“john.w@zylker.com”,
“zaaid”:4567899
},
“redirect_url”: “https://logistics.zylker.com/app/index.html",
“platform_type”:“web”
}’
{
"status": "success",
"data": {
"zaid": 1011481670,
"user_details": {
"user_id": 671930400,
"user_type": "App User",
"zuid": 3000000006001,
"zaaid": 1011520995,
"status": "ACTIVE",
"is_confirmed": true,
"email_id": "john.w@zylker.com",
"first_name": "John",
"last_name": "Winchester",
"created_time": "May 13, 2019 09:16 PM",
"modified_time": "May 13, 2019 09:16 PM",
"invited_time": "May 13, 2019 09:16 PM",
"role_id": 3000000005015
},
"redirect_url": "https://logistics.zylker.com/app/index.html",
"platform_type": "web",
"org_id": 1011520995
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
Obtener los detalles del usuario actual
Descripción
Esta API te permite obtener los detalles del usuario actual que ha iniciado sesión en la aplicación de Catalyst, en cuyo scope se está ejecutando la función.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user/current
Encabezados de la solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.projects.users.READ
Detalles de la respuesta
La respuesta contendrá los detalles del usuario actual, incluyendo sus valores de identificación como zaid, user_id, email_id y los detalles de su rol.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user/current
-H “Authorization: Zoho-oauthtoken 1000.910*************************6.2f*************************57”
{
"status": "success",
"data": {
"zuid": 3000000006111,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App Administrator",
"is_confirmed": true,
"email_id": "p.boyle@zylker.com",
"first_name": "Patricia",
"last_name": "Boyle",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005090,
"role_name": "App Administrator"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
Obtener los detalles de un usuario específico
Descripción
Esta API te permite obtener los detalles de un usuario específico de la aplicación de Catalyst, pasando su user_ID en la solicitud.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user/{user_id}
Encabezados de la solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.projects.users.READ
Detalles de la respuesta
La respuesta contendrá los detalles del usuario específico, incluyendo sus valores de identificación como zuid, user_id, email_id y los detalles de su rol.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user/671930409
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"zuid": 3171930400,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App User",
"is_confirmed": true,
"email_id": "john.w@zylker.com",
"first_name": "John",
"last_name": "Winchester",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
Obtener los detalles de todos los usuarios
Descripción
Esta API te permite obtener los detalles de todos los usuarios de las aplicaciones de Catalyst de una aplicación en particular a través de paginación. La paginación te permite recuperar la lista de usuarios en páginas mediante una iteración de llamadas a la API.
Por ejemplo, si necesitas que los registros de usuarios se obtengan en lotes de 200 como páginas individuales, debes incluir un parámetro start y un parámetro end en tu solicitud. Puedes establecer el índice de inicio en 0 usando el parámetro start, y especificar el número máximo de usuarios a obtener como 200 usando el parámetro end. Para obtener el siguiente conjunto de registros de usuarios, puedes ejecutar otra llamada a la API estableciendo el índice start en 200, y especificando el número de registros de usuarios en esa página usando el parámetro end de manera correspondiente.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user?start={start_index}&end={number_of_users}
El índice de inicio desde el cual obtener los registros de usuarios
Número de registros de usuarios a devolver en una sola página mediante paginación
Encabezados de la solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.projects.users.READ
Detalles de la respuesta
La respuesta contendrá los detalles de todos los usuarios de la aplicación, incluyendo sus valores de identificación como zuid, user_id, email_id y los detalles de su rol.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user?start=100&end=3
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"zuid": 3171930121,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App User",
"is_confirmed": true,
"email_id": "ron.grisham@zylker.com",
"first_name": "Ronald",
"last_name": "Grisham",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
},
{
"zuid": 3171930089,
"zaaid": 1019543293,
"status": "ACTIVE",
"user_id": 671930121,
"user_type": "App User",
"is_confirmed": true,
"email_id": "Lucy.p@zylker.com",
"first_name": "Lucy",
"last_name": "Pettigrew",
"created_time": "Jul 09, 2019 04:26 PM",
"modified_time": "Jul 09, 2019 04:26 PM",
"invited_time": "Jul 09, 2019 04:26 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
},
{
"zuid": 3171937685,
"zaaid": 1019540091,
"status": "ACTIVE",
"user_id": 671930888,
"user_type": "App User",
"is_confirmed": true,
"email_id": "zayn.ahmed@zylker.com",
"first_name": "Zayn",
"last_name": "Ahmed",
"created_time": "Jul 09, 2019 04:26 PM",
"modified_time": "Jul 09, 2019 04:26 PM",
"invited_time": "Jul 09, 2019 04:26 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
]
}
Eliminar usuario
Descripción
Esta API te permite eliminar un usuario y revocar completamente su acceso a tu aplicación de Catalyst.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user/{user_id}
Encabezados de la solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.projects.users.DELETE
Detalles de la respuesta
La respuesta contendrá los detalles del usuario eliminado, incluyendo sus valores de identificación como zaid, user_id, email_id y los detalles de su rol.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user/671930409
-H “Authorization: Zoho-oauthtoken 1000.910*************************6.2f*************************57”
{
"status": "success",
"data": {
"zuid": 3000000006111,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App Administrator",
"is_confirmed": true,
"email_id": "p.boyle@zylker.com",
"first_name": "Patricia",
"last_name": "Boyle",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005090,
"role_name": "App Administrator"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
Restablecer contraseña del usuario
Descripción
Esta API te permite restablecer la contraseña de un usuario de tu aplicación de Catalyst. Cuando se llama a esta API, se enviará un correo electrónico a la dirección de correo del usuario con un enlace para restablecer la contraseña. El usuario puede configurar una nueva contraseña para tu aplicación y guardarla al hacer clic en el enlace.
Detalles de la solicitud
URL de la solicitud
{api-domain}/baas/v1/project/{project_id}/project-user/forgotpassword
Encabezados de la solicitud
Content-Type: application/json
PROJECT_ID: {ZAID}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Propiedades JSON de la solicitud
Tamaño máximo: N/A
Tamaño máximo: 200
El JSON que contiene los detalles del usuario
Obligatorio: No
Tamaño máximo: 100
Obligatorio: No
Tamaño máximo: 100
Obligatorio: Sí
Tamaño máximo: N/A
Detalles de la respuesta
La respuesta contendrá el estado de la acción de restablecimiento de contraseña.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/forgotpassword
-H “Content-Type: application/json” \
-d ‘{
“user_details”:{
“email_id”:“p.boyle@zylker.com”
},
“platform_type”:“web”
}’
{
"status": "success",
"data": "Reset link sent to your p.boyle@zylker.com email address. Please check your email :)"
}
Cerrar sesión del usuario
Descripción
Un usuario de la aplicación de Catalyst puede cerrar su sesión activa actual en la aplicación usando esta solicitud de API. Catalyst no enviará ninguna respuesta para esta solicitud de API.
Detalles de la solicitud
URL de la solicitud
{application_domain}/baas/logout?logout=true&PROJECT_ID={project_id}
La dirección de dominio de la aplicación de Catalyst
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Data Store
Catalyst Data Store es un sistema de gestión de bases de datos relacionales basado en la nube que almacena los datos persistentes de tu aplicación en forma de tablas.
Las APIs de Data Store te permiten insertar y gestionar registros en las tablas del Data Store de tu proyecto, obtener detalles de tablas y columnas, e incluso realizar acciones de lectura y escritura masiva. Sin embargo, solo puedes crear una tabla y su esquema desde la consola de Catalyst.
Insertar una nueva fila en una tabla
Descripción
Esta API te permite insertar una nueva fila de datos o un registro en una tabla de Data Store, haciendo referencia al ID único o nombre de la tabla.
Debes pasar los nombres de las columnas y sus valores correspondientes para el registro en un array JSON en la solicitud, como se describe a continuación.
Nota:
-
La tabla y las columnas deben estar creadas previamente. Puedes crear una tabla y las columnas desde la consola.
-
Podrás insertar hasta 5000 registros en cada tabla por proyecto en el entorno de desarrollo. Puedes crear hasta 25,000 registros en total en cada proyecto en el entorno de desarrollo. No hay límites superiores para la creación de registros en el entorno de producción.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.rows.CREATE
Array JSON de solicitud
Debes enviar los nombres de las columnas y sus valores correspondientes en un array JSON de esta manera:
{
"column1_name": "column1_value",
"column2_name": "column2_value",
"column3_name": "column3_value",
.
.
}
donde column_name es el nombre de una columna única en la tabla, y column_value es su valor correspondiente en el registro.
Detalles de la respuesta
La respuesta contendrá los metadatos de la fila que se creó, como su ROWID y CREATEDTIME, y los nombres clave de las columnas y los valores que se insertaron.
curl -X POST \
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘[
{
“Department_ID”:“IT678”,
“Department_Name”:“Marketing”,
“Employee_Name”:“Robert Page”
}
]’
{
"status": "success",
"data": [
{
"CREATORID": "12096000000003003",
"MODIFIEDTIME": "2023-06-05 11:35:14:332",
"Department_ID": null,
"Employee_Name": "Robert Page",
"Department_Name": "Marketing",
"CREATEDTIME": "2023-06-05 11:35:14:332",
"ROWID": 12096000000642928
}
]
}
Obtener todas las filas de una tabla
Descripción
Esta API te permite obtener todas las filas de una tabla en particular de Data Store. Puedes hacer referencia a la tabla por su ID o nombre. La API incorpora paginación para obtener todas las filas. La paginación te permite recuperar los registros en páginas mediante una iteración de llamadas a la API.
Por ejemplo, si necesitas que las filas se obtengan en lotes de 100 como páginas individuales, debes incluir un parámetro max_rows en tu solicitud, que especifique el máximo de filas a obtener en cada página como 100.
Además, cada respuesta de la API contendrá un token que puedes pasar en la siguiente llamada a la API para obtener la siguiente página de filas. Este token autoriza la obtención subsiguiente de datos. Debes pasar la cadena de token obtenida en la respuesta de la llamada anterior a la API a través del parámetro next_token en la solicitud. No necesitas pasar el parámetro next_token en la primera llamada a la API. Puedes ejecutar una llamada a la API para cada iteración de esta manera y obtener todas las filas en páginas.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row?next_token={token_string}&max_rows={number_of_rows}
(no requerido para la primera llamada a la API) El valor del token obtenido de la llamada anterior a la API que se debe pasar para obtener el siguiente conjunto de filas mediante paginación
(opcional) El número máximo de filas que se deben devolver en una sola página mediante paginación. La API devolverá 200 filas en una sola página por defecto si no se especifica este valor.
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.rows.READ
Detalles de la respuesta
La respuesta devolverá las filas obtenidas a través de la llamada a la API en páginas según el valor de max_rows que especifiques. Si hay más filas disponibles que la cantidad solicitada o el conteo de max_rows, la respuesta también contendrá el token que debes pasar para obtener el siguiente conjunto de filas como next_token. Si no hay más registros por obtener, la respuesta no contendrá un token.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/CustomerDetails/row?max_rows=4&next_token=*************
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:16:41",
"Department_ID": "IT148",
"Department_Name": "Admin",
"Employee_Name": "Eric Hyde",
"CREATEDTIME": "2019-03-06 10:16:41",
"ROWID": 56000000342025,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:18:56",
"Department_ID": "IT170",
"Department_Name": "Sales",
"Employee_Name": "Steven Kelso",
"CREATEDTIME": "2019-03-06 10:18:56",
"ROWID": 56000000342026,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:19:00",
"Department_ID": "IT190",
"Department_Name": "Marketing",
"Employee_Name": "Micheal Forman",
"CREATEDTIME": "2019-03-06 10:18:58",
"ROWID": 56000000342027,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:45:11",
"Department_ID": "IT111",
"Department_Name": "Support",
"Employee_Name": "Madeline Burkhart",
"CREATEDTIME": "2019-03-06 10:18:34",
"ROWID": 56000000342028,
"doubleDataType": null
},
],
"more_records" : true,
"next_token" : "{{token}}"
}
{
"status": "success",
"data": [
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:16:41",
"Department_ID": "IT148",
"Department_Name": "Admin",
"Employee_Name": "Eric Hyde",
"CREATEDTIME": "2019-03-06 10:16:41",
"ROWID": 56000000342025,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:18:56",
"Department_ID": "IT170",
"Department_Name": "Sales",
"Employee_Name": "Steven Kelso",
"CREATEDTIME": "2019-03-06 10:18:56",
"ROWID": 56000000342026,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:19:00",
"Department_ID": "IT190",
"Department_Name": "Marketing",
"Employee_Name": "Micheal Forman",
"CREATEDTIME": "2019-03-06 10:18:58",
"ROWID": 56000000342027,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:45:11",
"Department_ID": "IT111",
"Department_Name": "Support",
"Employee_Name": "Madeline Burkhart",
"CREATEDTIME": "2019-03-06 10:18:34",
"ROWID": 56000000342028,
"doubleDataType": null
},
],
"more_records" : false
}
Actualizar una fila en una tabla
Descripción
Esta API te permite actualizar una fila en particular de una tabla en Catalyst Data Store, haciendo referencia al ID de la tabla o al nombre de la tabla. Debes enviar los datos que se van a actualizar en el registro en el JSON de la solicitud como se describe a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.rows.UPDATE
Formato JSON de la solicitud
Debes enviar los nombres de las columnas y sus valores correspondientes que se van a actualizar en la solicitud, junto con el ROWID del registro, como un array JSON de esta manera:
{
“column1_name”: “column1_value”,
“column2_name”: “column2_value”,
“column3_name”: “column3_value”,
.
.
“ROWID”:{row_id of the record}
}
Propiedades del JSON de solicitud
Detalles de la respuesta
La respuesta contendrá los metadatos de la fila que se actualizó, como su ROWID y CREATEDTIME, y los nombres clave de las columnas y valores actualizados.
curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘[
{
“Department_Name”:“Finance”,
“Employee_Name”:“Morgan Jones”,
“ROWID”:3376000000170191
}
]’
{
"status": "success",
"data": [
{
"CREATORID": 3376000000002099,
"MODIFIEDTIME": "2019-02-26 11:18:49",
"Department_ID":"IT245",
"Department_Name":"Finance",
"Employee_Name": "Morgan Jones",
"CREATEDTIME": "2019-02-26 11:18:49",
"ROWID": 3376000000170191
}
]
}
Eliminar una fila en una tabla
Descripción
Esta API te permite eliminar un registro o una fila en particular de una tabla en Data Store, haciendo referencia al ID único o nombre de la tabla. La fila se identifica por su ROWID.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row/{row_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.rows.DELETE
Detalles de la respuesta
La respuesta contendrá los metadatos de la fila que se eliminó, como su ROWID y CREATEDTIME, y los nombres clave de las columnas y valores de la fila.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row/3376000000171021
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-02-26 11:18:49",
"Department_ID": "IT809"
"Department_Name": "Accounting",
"Customer_Name": "Jason Pierre",
"CREATEDTIME": "2019-02-26 11:18:49",
"ROWID": 3376000000171021,
"doubleDataType": null
}
}
Obtener los metadatos de una tabla específica
Descripción
Esta API te permite recuperar los metadatos de una tabla específica de Data Store, haciendo referencia al ID único o nombre de la tabla.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.READ
Detalles de la respuesta
La respuesta devolverá los metadatos de la tabla, que incluirán los detalles de la tabla como el table_id y el table_name, y los metadatos de todas las columnas que contiene, como el column_id, column_name y data_type de cada columna.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"table_id": 56000000111778,
"project_id": {
"id": 4000000006007,
"project_name": "HRApp"
},
"table_name": "EmpDetails",
"modified_by": {
"is_confirmed":true,
"zuid": 1019540152,
"user_id": 671930455,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"modified_time": "2019-02-19T02:45:16+05:30",
"column_details": [
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091030,
"column_name": "ROWID",
"category": 1,
"data_type": "bigint",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": false
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091031,
"column_name": "CREATORID",
"category": 1,
"data_type": "bigint",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091032,
"column_name": "CREATEDTIME",
"category": 1,
"data_type": "datetime",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091033,
"column_name": "MODIFIEDTIME",
"category": 1,
"data_type": "datetime",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091034,
"column_name": "EmpID",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 6,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": true,
"search_index_enabled": true
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091035,
"column_name": "EmpName",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 30,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": false,
"search_index_enabled": false
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091036,
"column_name": "DeptName",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 30,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": false,
"search_index_enabled": false
}
],
"table_scope": "ORG"
}
}
Obtener los metadatos de todas las tablas
Descripción
Esta API te permite recuperar los metadatos de todas las tablas de tu proyecto en Data Store.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.READ
Detalles de la respuesta
La respuesta devolverá los metadatos de todas las tablas, que incluirán los detalles de la tabla como el table_id y el table_name de cada tabla, y los detalles del usuario que modificó las tablas por última vez.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":[
{
"project_id":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"table_name":"CustomerInfo",
"modified_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_id":671930111
},
"modified_time":"Apr 11, 2020 10:33 PM",
"table_id":3376000000081234
},
{
"project_id":{
"project_name":"ShipmentTracking",
"id":3376000000061190
},
"table_name":"EmpInfo",
"modified_by":{
"zuid":1019540232,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930455
},
"modified_time":"Mar 09, 2020 03:16 AM",
"table_id":3376000000017896
}
]
}
Obtener los metadatos de una columna específica
Descripción
Esta API te permite recuperar los metadatos de una columna específica en una tabla de Data Store. La tabla se identifica por su ID único o nombre, y la columna se identifica por el ID de columna.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/column/{column_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.columns.READ
Detalles de la respuesta
La respuesta devolverá los metadatos de la columna específica, como su column_id, column_name y data_type.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/column/4000000042018
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"table_id": 56000000118,
"column_sequence": 3,
"column_id": 4000000042018,
"column_name": "Department",
"category": 2,
"data_type": "text",
"is_read_only": false,
"max_length": 100,
"is_mandatory": true,
"default_value": "Admin",
"is_unique": false,
"search_index_enabled": false
}
}
Obtener los metadatos de todas las columnas
Descripción
Esta API te permite recuperar los metadatos de todas las columnas de una tabla en Data Store, haciendo referencia al ID único o nombre de la tabla.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/column
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.columns.READ
Detalles de la respuesta
La respuesta devolverá los metadatos de todas las columnas, como el column_id, column_name y data_type de cada columna.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/column
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":[
{
"table_id":829000000037723,
"column_sequence":1,
"column_name":"ROWID",
"category":1,
"data_type":"bigint",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":false,
"column_id":829000000037726
},
{
"table_id":829000000037723,
"column_sequence":2,
"column_name":"CREATORID",
"category":1,
"data_type":"bigint",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":true,
"column_id":829000000037728
},
{
"table_id":829000000037723,
"column_sequence":3,
"column_name":"CREATEDTIME",
"category":1,
"data_type":"datetime",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":true,
"column_id":829000000037730
},
{
"table_id":829000000037723,
"column_sequence":4,
"column_name":"MODIFIEDTIME",
"category":1,
"data_type":"datetime",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":true,
"column_id":829000000037732
},
{
"table_id":829000000037723,
"column_sequence":5,
"column_name":"EmpID",
"category":2,
"data_type":"bigint",
"is_read_only":false,
"max_length":15,
"is_mandatory":true,
"decimal_digits":2,
"is_unique":true,
"search_index_enabled":false,
"column_id":829000000038445
},
{
"table_id":829000000037723,
"column_sequence":6,
"column_name":"EmpName",
"category":2,
"data_type":"text",
"is_read_only":false,
"max_length":50,
"is_mandatory":true,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":false,
"column_id":829000000038450
}
]
}
Truncar una tabla
Descripción
Esta API te permite truncar una tabla específica en Data Store, haciendo referencia al ID único o nombre de la tabla.
La operación de truncado elimina todos los registros de la tabla, conservando su esquema. Las columnas de la tabla y los metadatos de la tabla seguirán disponibles después de que la operación haya finalizado.
Recibirás notificaciones en tu consola de Catalyst sobre las actualizaciones de la operación.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/truncate
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.rows.DELETE
Detalles de la respuesta
La respuesta devolverá el estado de la operación de truncado.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/NewsHeadlines/truncate
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": "The table will be truncated Shortly. Kindly Check Notification bar for updates"
}
Lectura masiva de registros
La operación de lectura masiva puede leer miles de registros de una tabla específica en Data Store y generar un archivo CSV con los resultados de la operación de lectura, si el trabajo se ejecuta correctamente. Esta operación intensiva en datos se puede realizar en una sola ejecución de API.
Catalyst admite tres APIs para la operación de lectura masiva: una API para crear la lectura masiva, una API para verificar el estado de la lectura masiva para comprobar el estado de la ejecución del trabajo manualmente, y una API para descargar el resultado de la lectura masiva para descargar los resultados. También puedes configurar una URL de callback para habilitar la publicación automática de las respuestas de estado del trabajo en ella.
Crear un trabajo de lectura masiva
Descripción
Esta API activa la operación de lectura masiva para obtener los registros de la tabla en Data Store que coincidan con los criterios que especifiques en el JSON de entrada. La tabla se identifica usando su ID de tabla único o el nombre de la tabla.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{projectId}/bulk/read
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.bulk.READ
Propiedades del JSON de solicitud
La entrada para la solicitud de la API de lectura masiva debe enviarse en formato JSON. Los parámetros de la solicitud se explican a continuación.
La sección donde puedes definir las condiciones y criterios para el trabajo de lectura masiva
El archivo CSV generado como resultado del proceso de lectura masiva contiene doscientos mil registros en una página.
El valor de página ‘1’ indica que los primeros doscientos mil registros que coincidan con tu consulta serán exportados. Puedes obtener registros subsiguientes aumentando el valor de página.
Por ejemplo, si deseas obtener registros del rango 200,001 a 400,000, debes especificar el valor de página como ‘2’.
Valor predeterminado: 1
Columnas específicas en los registros que necesitan obtenerse de la tabla. Si no especificas las columnas, se seleccionarán y obtendrán todas las columnas.
Puedes incluir múltiples columnas en un array. Consulta la ventana de código de la solicitud de ejemplo.
Un conjunto de condiciones en base a las cuales se obtendrán los registros
El operador que vinculará los grupos de criterios entre sí.
Operadores compatibles: AND, OR
Si defines dos o más grupos de criterios, puedes usar el operador AND o OR en tu solicitud. Por ejemplo, puedes especificar un criterio como “column1 equal value 1 AND column2 contains value 2” en el formato especificado en la sección anterior.
Puedes incluir hasta 25 conjuntos de criterios en esta sección. El ejemplo muestra 3 conjuntos de criterios.
El operador de comparación que coincide el nombre de la columna con el valor del criterio
Comparadores compatibles: equal, not_equal, greater_than, greater_equal, less_than, less_equal, starts_with, ends_with, contains, not_contains, in, not_in, between, not_between
Nota:
-
Puedes especificar múltiples valores para los comparadores in y not_in, separados por comas.
-
Catalyst solo admite el comparador equal para una columna cifrada. No podrás usar otros comparadores como criterio para una columna cifrada.
La sección donde puedes definir las propiedades de la URL de callback, donde se enviarán las respuestas JSON automáticas de los estados del trabajo
La URL donde se enviarán las respuestas automáticas usando el método HTTP POST, cada vez que cambie el estado del trabajo. La información sobre los detalles del trabajo estará contenida en el cuerpo de la respuesta JSON.
Si no configuras una URL de callback, debes verificar manualmente el estado del procesamiento del trabajo cuando lo necesites, usando la API para verificar el estado de la lectura masiva.
Encabezados que necesitas que se pasen en la respuesta JSON a la URL de callback.
Debes especificar los encabezados como:
{
"{header_name_1}" : “{header_value_1}”,
"{header_name_2}" : “{header_value_2}”
}
y así sucesivamente. Consulta el código de la solicitud de ejemplo.
Parámetros que necesitas que se añadan a la URL de callback
Debes especificar los parámetros como:
{
"{param_name_1}" : “{param_value_1}”,
"{param_name_2}" : “{param_value_2}”
}
y así sucesivamente. Consulta el código de la solicitud de ejemplo.
Detalles de la respuesta
Hay tres estados de procesamiento del trabajo que generarán tres respuestas diferentes:
-
In-Progress: Cuando ejecutas la API, Catalyst te enviará inmediata y automáticamente una respuesta indicando que la ejecución del trabajo está en progreso. Si configuraste una URL de callback en la solicitud, la respuesta también se publicará en la URL en el formato que definiste.
La respuesta contendrá un parámetro job_id que puedes usar para verificar el estado de la ejecución del trabajo en respuestas subsiguientes, si no configuraste una URL de callback.
-
Success: La respuesta del estado exitoso contendrá una URL de descarga, donde puedes descargar un archivo CSV que contiene los registros que coinciden con tu consulta. Si no configuraste una URL de callback, esta respuesta no será enviada por Catalyst automáticamente.
-
Failed: La respuesta del estado fallido contendrá una descripción del error ocurrido y los detalles. Si no configuraste una URL de callback, esta respuesta no será enviada por Catalyst automáticamente.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read
-H “Authorization: Zoho-oauthtoken 1000.91016.2f*57”
-d ‘{
“table_identifier”: “EmpDetails”,
“query” : {
“page” : “1”,
“select_columns” : [
“EmpID”, “EmpName”, “Department”
],
“criteria”: {
“group_operator”: “or”,
“group”: [
{
“column_name”: “Department”,
“comparator”: “equal”,
“value”: “Marketing”
} ,
{
“column_name”: “EmpID”,
“comparator”: “greater_than”,
“value”: “1000”
} ,
{
“column_name”: “EmpName”,
“comparator”: “starts_with”,
“value”: “S”
}
]
}
},
“callback” : {
“url” : “https://hr.zylker.com/es/EmpRecords/_callback.php",
“headers” : {
“src” : “ZCatalyst”,
“operation” : “bulkreadAPI”
},
“params” : {
“project_name” : “EmployeeDatabase”
}
}
}’
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "In-Progress",
"operation": "read",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "In-Progress",
"operation": "read",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000117007,
"status": "Failed",
"operation": "read",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:00 PM",
"results": {
"description": "The column ID in select_columns is invalid",
}
}
}
Verificar estado de lectura masiva
Descripción
Puedes ejecutar esta API para verificar manualmente el estado del trabajo de lectura masiva que iniciaste previamente.
Si no configuraste una URL de callback en tu solicitud JSON, debes verificar el estado del trabajo tú mismo ejecutando esta API. Debes usar el job_id que se te envía en la respuesta automática de estado en progreso cuando inicias la operación de lectura masiva, para verificar el estado del trabajo posteriormente.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bulk/read/{job_id}
El ID único del trabajo que se envió en la respuesta inicial de estado en progreso después de ejecutar la API de lectura masiva
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.bulk.READ
Detalles de la respuesta
La respuesta JSON para el estado exitoso contendrá los detalles del trabajo ejecutado, junto con una URL de descarga donde puedes descargar un archivo CSV que contendrá una lista de registros que coinciden con la consulta de tu trabajo de lectura masiva.
La respuesta JSON para el estado fallido contendrá los detalles del trabajo ejecutado, junto con una descripción del error que ocurrió en el procesamiento del trabajo y sus detalles, como las filas que se omitieron de la lectura y las razones.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read/2000000118004
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "In-Progress",
"operation": "read",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "Completed",
"operation": "read",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM",
"results": {
"download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/read/2000000117007/download",
"description": "Bulk READ job 2000000117007 completed.",
"details": [
{
"table_id": 3376000000165541,
"records_processed": 21,
"more_records": false
}
]
}
}
}
{
"status": "success",
"data": {
"job_id": 2000000117007,
"status": "Failed",
"operation": "read",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:00 PM",
"results": {
"description": "The column ID in select_columns is invalid",
}
}
}
Descargar resultado de lectura masiva
Descripción
Puedes ejecutar esta API para descargar el resultado de un trabajo de lectura masiva exitoso que iniciaste. Esta URL también se enviará en la respuesta JSON para el estado exitoso.
El archivo CSV descargado con los resultados contendrá una lista de todos los registros que coinciden con la consulta de tu trabajo de lectura masiva.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bulk/read/{job_id}/download
El ID único del trabajo que se envió en la respuesta inicial de estado en progreso después de ejecutar la API de lectura masiva
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.bulk.READ
Detalles de la respuesta
El archivo con los resultados de la lectura masiva se descargará automáticamente en el directorio configurado en tu sistema después de ejecutar esta API.
Formato de archivo: Archivo ZIP que contiene el archivo CSV con los resultados
Archivo de resultados de ejemplo que muestra los detalles de un trabajo de lectura masiva:
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read/2000000118004/download
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
Bulk Write de registros
La operación Bulk Write puede obtener miles de registros desde un archivo CSV cargado en un bucket en Stratus e insertarlos en una tabla específica en el Data Store. Esta operación de gran volumen de datos puede realizarse en una sola ejecución de API.
Después de que la operación de escritura masiva se haya ejecutado exitosamente, se generará un archivo de informe CSV que contiene los detalles de la ejecución del trabajo en una URL de descarga.
Catalyst admite tres APIs para la operación de escritura masiva: una API Create Bulk Write, una API Check Bulk Write Status para verificar el estado de la ejecución del trabajo manualmente, y una API Download Bulk Write Result para descargar los resultados. También puedes configurar una URL de callback para habilitar la publicación automática de las respuestas de estado del trabajo en ella.
Crear un trabajo de Bulk Write
Descripción
Esta API activa la operación de escritura masiva para obtener los registros de un archivo CSV almacenado en Stratus y exportarlos a una tabla en el Data Store, según los criterios que especifiques en el JSON de entrada. El archivo CSV se referencia usando su Object URL en Stratus, y la tabla se referencia usando su ID único de tabla o el nombre de la tabla.
Nota:
-
Asegúrate de haber cargado el archivo CSV requerido en Stratus antes de comenzar a ejecutar esta operación.
-
La primera fila del archivo CSV debe ser la fila de encabezado, es decir, los nombres de las columnas deben estar presentes como fila de encabezado.
-
El archivo CSV debe contener datos en el formato que se adhiere a los estándares de archivos CSV. Si el archivo no tiene el formato estándar, los datos escritos en la tabla podrían estar corruptos.
-
Puedes insertar 5000 registros en cada tabla por proyecto en el entorno de desarrollo usando esta API. Si el archivo CSV contiene más registros que esa cantidad, los primeros 5000 registros se escribirán en la tabla. Los demás se omitirán en el entorno de desarrollo. No hay límites de tabla para la inserción en el entorno de producción. Sin embargo, la API Bulk Write puede insertar hasta 100000 registros en una sola llamada API desde un archivo CSV incluso en el entorno de producción. Si necesitas escribir más registros, puedes hacerlo en lotes de 100000 registros enviando múltiples solicitudes de la API Bulk Write en consecuencia.
Hay tres operaciones que se pueden realizar usando esta API:
- Insert: Inserta nuevas filas de datos en la tabla desde el archivo CSV
- Update: Actualiza filas de datos existentes en la tabla. Los registros se identifican ya sea usando una columna única en la tabla, o usando sus ROWIDs generados en el Data Store.
- Upsert: Habilita las operaciones de inserción y actualización al mismo tiempo. Si el registro ya existe, la fila se actualiza. Si el registro no existe, se inserta una nueva fila con los datos.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{projectId}/bulk/write
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.bulk.CREATE
Propiedades JSON de la solicitud
La entrada para la solicitud de la API Bulk Write debe enviarse en formato JSON. Los parámetros de la solicitud se explican a continuación.
Especifica la operación a ejecutar usando la API.
Valores permitidos: insert, update, upsert
Operación predeterminada: insert
La columna única usando la cual se identifican los registros.
Por ejemplo, si especificas una columna única llamada ‘EmployeeID’ como el valor de find_by, Catalyst buscará los registros en la tabla del Data Store usando el valor de EmployeeID. Para la operación update, Catalyst actualizará las filas que coincidan con el EmployeeID del archivo CSV. Para la operación upsert, Catalyst actualizará las filas existentes e insertará nuevas filas si no hay registros con valores de EmployeeID coincidentes.
Update: Puede ser una columna con valores únicos según la configuración en el Data Store, o el ROWID generado por Catalyst para los registros.
Upsert: Solo puedes especificar una columna con valores únicos según la configuración en el Data Store. No podrás especificar el ROWID como valor de find_by. Esto se debe a que upsert insertará nuevas filas si no se encuentran coincidencias, y los valores de ROWID no estarán disponibles para filas que no existen en el Data Store.
Insert: Si especificas una columna find_by para una operación insert, cualquier registro que coincida con los valores de la columna del archivo CSV se omitirá y no se insertará en la tabla del Data Store. Esto se debe a que insert no puede actualizar si un registro dado ya existe.
Mapeo de clave foránea para las columnas que son claves primarias en otras tablas. Esto se especifica si alguna columna importada desde el archivo CSV debe configurarse como clave foránea.
Debes mapear las claves foráneas en el siguiente formato:
{
“local_column” : “local_column_name_1”,
“reference_column” : “reference_column_name_1”
}
donde local_column es el nombre de la columna en la tabla donde se procesa la operación de escritura masiva, y reference_column es el nombre de la columna en la tabla en la que es una clave primaria.
Consulta el código de solicitud de ejemplo.
La sección donde puedes definir las propiedades de la URL de callback, donde se enviarán las respuestas JSON automáticas de los estados del trabajo.
La URL donde se enviarán las respuestas automáticas usando el método HTTP POST, cada vez que el estado del trabajo cambie. La información sobre los detalles del trabajo estará contenida en el cuerpo de la respuesta JSON.
Si no configuras una URL de callback, debes verificar manualmente el estado del procesamiento del trabajo cuando lo necesites, usando la API Check Bulk Write Status.
Encabezados que necesitas que se pasen en la respuesta JSON a la URL de callback
Debes especificar los encabezados como:
{
"{header_name_1}" : “{header_value_1}”,
"{header_name_2}" : “{header_value_2}”
}
y así sucesivamente. Consulta el código de solicitud de ejemplo.
Parámetros que necesitas que se agreguen a la URL de callback
Debes especificar los parámetros como:
{
"{param_name_1}" : “{param_value_1}”,
"{param_name_2}" : “{param_value_2}”
}
y así sucesivamente. Consulta el código de solicitud de ejemplo.
Detalles de la respuesta
Hay tres estados de procesamiento del trabajo que generarán tres respuestas diferentes:
-
In-Progress: Cuando ejecutas la API, Catalyst te enviará inmediata y automáticamente una respuesta indicando que la ejecución del trabajo está en progreso. Si has configurado una URL de callback en la solicitud, la respuesta también se publicará en la URL en el formato que definiste.
La respuesta contendrá un parámetro job_id que puedes usar para verificar el estado de la ejecución del trabajo para respuestas posteriores, si no has configurado una URL de callback.
-
Success: La respuesta del estado exitoso contendrá una URL de descarga, donde puedes descargar un archivo de informe CSV que contiene los detalles de la ejecución del trabajo. Listará todos los registros que fueron omitidos de la escritura junto con las razones. Si no has configurado una URL de callback, esta respuesta no será enviada por Catalyst automáticamente.
-
Failed: La respuesta del estado fallido contendrá una descripción del error que ocurrió y los detalles. Si no has configurado una URL de callback, esta respuesta no será enviada por Catalyst automáticamente.
curl -X POST https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write
-H “Authorization: Zoho-oauthtoken 1000.91016.2f*57”
-d ‘{
“table_identifier”: “3376000000165511”,
“operation”: “insert”,
“object_details”: {
“bucket_name”: “zylker-emp”,
“object_key”: “employees/emp_rec.csv”,
“version_id”: “3546576879809”
},
“callback”: {
“url”: “https://hr.zylker.com/es/EmpRecords/_callback.php",
“headers”: {
“src”: “ZCatalyst”,
“operation”: “bulkwriteAPI”
},
“params”: {
“project_name”: “EmployeeDatabase”
}
},
“find_by”: “EmpID”,
“fk_mapping”: [
{
“local_column”: “EmployeeID”,
“reference_column”: “EmpID”
},
{
“local_column”: “DepartmentID”,
“reference_column”: “DeptID”
}
]
}’
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "In-Progress",
"operation": "insert",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165511,
"object_details": {
"bucket_name": "zylker-emp",
"object_key" : "employees/emp_rec.csv",
"version_id":"3546576879809"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:33 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Completed",
"operation": "insert",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/write/2000000110013/download",
"description": "Bulk WRITE job completed. ",
"details": [
{
"table_id": 3376000000165511,
"records_processed": 176
}
]
}
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Failed",
"operation": "insert",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
}
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"description": "The reference_column 'DeptID' in fk_mapping of table 3376000000165511 is not a unique column",
"details": [ ]
}
}
}
Verificar estado de Bulk Write
Descripción
Puedes ejecutar esta API para verificar manualmente el estado del trabajo de escritura masiva que iniciaste previamente.
Si no habías configurado una URL de callback en tu solicitud JSON, debes verificar el estado del trabajo tú mismo ejecutando esta API. Debes usar el job_id que se te envió en la respuesta automática de estado in-progress cuando iniciaste la operación de escritura masiva, para verificar el estado del trabajo posteriormente.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bulk/write/{job_id}
El ID único del trabajo que se envió en la [respuesta de estado in-progress](/es/api/introduction/overview-and-prerequisites/#response-details) inicial después de que se ejecutó la API Bulk Write
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.bulk.CREATE
Detalles de la respuesta
La respuesta JSON para el estado exitoso contendrá los detalles del trabajo ejecutado, junto con una URL de descarga, donde puedes descargar un archivo de informe CSV que contendrá los detalles de la ejecución del trabajo. Listará todos los registros que fueron omitidos de la escritura junto con las razones.
La respuesta JSON para el estado fallido contendrá los detalles del trabajo ejecutado, junto con una descripción del error ocurrido en el procesamiento del trabajo y sus detalles.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write/2000000110044
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "In-Progress",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv",
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:33 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Completed",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/write/2000000110013/download",
"description": "Bulk WRITE job completed. ",
"details": [
{
"table_id": 3376000000165511,
"records_processed": 176
}
]
}
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Failed",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"description": "The reference_column 'DeptID' in fk_mapping of table 3376000000165511 is not a unique column",
"details": [ ]
}
}
}
Descargar resultado de Bulk Write
Descripción
Puedes ejecutar esta API para descargar el resultado de un trabajo de escritura masiva exitoso que iniciaste. Esta URL también se enviará en la respuesta JSON para el estado exitoso.
El archivo CSV descargado contendrá los detalles de la ejecución del trabajo. Listará todos los registros que fueron omitidos de la escritura junto con las razones.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bulk/write/{job_id}/download
El ID único del trabajo que se envió en la [respuesta de estado in-progress](/es/api/introduction/overview-and-prerequisites/#response-details) inicial después de que se ejecutó la API Bulk Write
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.bulk.CREATE
Detalles de la respuesta
El archivo de resultados de la escritura masiva se descargará automáticamente al directorio configurado en tu sistema después de que ejecutes esta API.
Formato de archivo: Archivo ZIP que contiene el archivo CSV de resultados
Archivo de resultados de ejemplo que muestra los detalles de un trabajo de escritura masiva:
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write/2000000110044/download
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
Eliminación masiva de filas en una tabla
Descripción
Esta API te permite eliminar registros o filas de datos de forma masiva de una tabla específica en Data Store. La tabla se identifica por su ID único o nombre.
La operación de eliminación masiva puede eliminar un máximo de 200 filas en una sola llamada a la API. Puedes elegir las filas que se van a eliminar pasando los ROWIDs únicos de esas filas como parámetros en la URL de solicitud, como se muestra en la solicitud de ejemplo.
Debes incluir al menos un ROWID y puedes incluir hasta 200 ROWIDs en la solicitud.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row?ids={rowID_1},{rowID_2},{rowID_3}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.rows.DELETE
Detalles de la respuesta
La respuesta contiene los datos de todas las filas que se eliminaron mediante la operación, incluyendo sus metadatos como el ROWID y CREATEDTIME, y los nombres clave de las columnas y valores de cada fila.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row?ids=1028000000171815,1028000000171810,1028000000171805,1028000000171617
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:21:830",
"Department_ID":"IT245",
"Department_Name":"Finance",
"Employee_Name": "Morgan Jones",
"CREATEDTIME": "2020-11-19 15:20:21:830",
"ROWID": "1028000000171815"
},
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:34:503",
"Department_ID":"IT121",
"Department_Name":"HR",
"Employee_Name": "Leena Medley",
"CREATEDTIME": "2020-11-19 15:20:34:503",
"ROWID": "1028000000171810"
},
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:42:314",
"Department_ID":"IT783",
"Department_Name":"Marketing",
"Employee_Name": "Tamira Shah",
"CREATEDTIME": "2020-11-19 15:20:42:314",
"ROWID": "1028000000171805"
},
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:42:314",
"Department_ID":"IT098",
"Department_Name":"Sales",
"Employee_Name": "Julia McGregor",
"CREATEDTIME": "2020-11-19 15:20:42:314",
"ROWID": "1028000000171617"
}
]
}
NoSQL
Catalyst NoSQL es una función de almacenamiento de datos no relacional, NoSQL completamente administrada que te permite almacenar los datos semi-estructurados, no estructurados y dispares de tus aplicaciones. Catalyst admite almacenamiento de datos de tipo documento en formato JSON basado en pares clave-valor.
Las APIs de Catalyst NoSQL te permiten realizar operaciones CRUD en tus tablas NoSQL. Puedes insertar, actualizar, eliminar u obtener elementos, así como ejecutar consultas en una tabla o en el índice de una tabla.
Insertar elemento
Descripción
Esta API te permite insertar un nuevo elemento en una tabla NoSQL en tu proyecto. La tabla se referencia por su ID único o nombre.
Puedes insertar un elemento con o sin especificar condiciones pasando los datos en el formato JSON personalizado.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.nosql.item.INSERT
Propiedades JSON de la solicitud
Los datos existentes de la tabla se obtienen y evalúan contra esta condición. Los elementos se insertan solo si la evaluación es verdadera. Si no hay datos existentes, las condiciones se ignoran y los elementos se insertan. Hay tres formas de inicializar una condición:
Detalles de la respuesta
La respuesta devolverá el estado de la operación de inserción, así como los detalles del elemento insertado como el table_name, partition_key y sort_key, si están configurados.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
},
“Location”: {
“M”: {
“Country”: {
“S”: “USA”
},
“City”: {
“S”: “New York”
}
}
}
}
}’
{
"status": "success",
"data": {
"table_name": "employeeDetails",
"project_details": {
"id": 4000000006007,
"project_name": "EmpDatabase",
"project_type": "Live"
}
}
}
Actualizar elemento
Descripción
Esta API te permite actualizar un elemento de los datos existentes en una tabla NoSQL en tu proyecto. La tabla se referencia por su ID único o nombre.
Puedes pasar los atributos a actualizar con o sin especificar condiciones en el formato JSON personalizado.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.nosql.item.UPDATE
Propiedades JSON de la solicitud
Indica el atributo a actualizar junto con su valor. La actualización puede ser de dos tipos: PUT (para agregar un nuevo atributo dentro del elemento) y DELETE (para eliminar un atributo del elemento). El attribute_path indica la ruta dentro del elemento donde se debe realizar la operación real. El valor a actualizar puede ser de dos tipos:
Hay cuatro funciones que pueden usarse:
if_not_exists - Verifica la existencia del atributo y declara un valor si no está presente.
append_list - Agrega datos a una lista
add - Agrega un valor junto con el valor existente o agrega un elemento en un conjunto
reduction - Resta un valor del valor existente o elimina un elemento en un conjunto.
Los datos existentes de la tabla se obtienen y evalúan contra esta condición. Los elementos se insertan solo si la evaluación es verdadera. Si no hay datos existentes, las condiciones se ignoran y los elementos se insertan. Hay tres formas de inicializar una condición:
Detalles de la respuesta
La respuesta devolverá el estado de la operación de inserción, así como los detalles del elemento actualizado como el table_name, partition_key y sort_key, si están configurados.
curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
keys:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
update_attributes:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
},
“Location”: {
“M”: {
“Country”: {
“S”: “USA”
},
“City”: {
“S”: “New York”
}
}
}
}
}
}’
{
"status": "success",
"data": {
"table_name": "employeeDetails",
"project_details": {
"id": 4000000006007,
"project_name": "EmpDatabase",
"project_type": "Live"
}
}
}
Obtener elemento
Descripción
Esta API te permite obtener un elemento de una tabla NoSQL en tu proyecto. La tabla se referencia por su ID único o nombre.
Puedes especificar los atributos de los elementos a obtener, e incluso indicar si necesitan obtenerse del clúster maestro o de un clúster esclavo.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item/fetch
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.nosql.item.READ
Propiedades JSON de la solicitud
Detalles de la respuesta
La respuesta devolverá el estado de la operación de obtención, así como los elementos que se obtienen. Se obtendrán todos los atributos o los atributos especificados de los elementos.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item/fetch
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
keys:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’
{
"status": "success",
"data": {
fetched_attributes:{
"item": {
"EmpID": {
"N": "10999"
},
"FirstName":{
"S": "Paul"
},
"LastName":{
"S": "Smith"
},
"PriorExperience":{
"BOOL": false
}
}
}
}
}
Eliminar elemento
Descripción
Esta API te permite insertar un nuevo elemento en una tabla NoSQL en tu proyecto. La tabla se referencia por su ID único o nombre.
Puedes insertar un elemento con o sin especificar condiciones pasando los datos en el formato JSON personalizado.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.nosql.item.INSERT
Propiedades JSON de la solicitud
Los datos existentes de la tabla se obtienen y evalúan contra esta condición. Los elementos se insertan solo si la evaluación es verdadera. Si no hay datos existentes, las condiciones se ignoran y los elementos se insertan. Hay tres formas de inicializar una condición:
Detalles de la respuesta
La respuesta devolverá el estado de la operación de inserción, así como los detalles del elemento insertado como el table_name, partition_key y sort_key, si están configurados.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
},
“Location”: {
“M”: {
“Country”: {
“S”: “USA”
},
“City”: {
“S”: “New York”
}
}
}
}
}’
{
"status": "success",
"data": {
"table_name": "employeeDetails",
"project_details": {
"id": 4000000006007,
"project_name": "EmpDatabase",
"project_type": "Live"
}
}
}
Consultar tabla
Descripción
Esta API te permite consultar una tabla NoSQL en tu proyecto y obtener datos. La tabla se referencia por su ID único.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item/query
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.nosql.POST
Propiedades JSON de la solicitud
Detalles de la respuesta
La respuesta devolverá el estado de la operación de consulta, así como los elementos que se obtienen según las condiciones establecidas en la consulta.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d -d ‘{
key_condition:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’
{
“status”: “success”,
“data”: {
fetched_data:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
}
}
}
}
}
Consultar índice
Descripción
Esta API te permite consultar un índice NoSQL en tu proyecto y obtener datos. El índice se referencia por su ID único.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}//index/{{index_identifier/}}/item/query
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.nosql.POST
Propiedades JSON de la solicitud
Detalles de la respuesta
La respuesta devolverá el estado de la operación de consulta, así como los elementos que se obtienen según las condiciones establecidas en la consulta.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/index/786387162881/item/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d -d ‘{
key_condition:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’
{
“status”: “success”,
“data”: {
fetched_data:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
}
}
}
}
}
Stratus
Stratus es la solución robusta de almacenamiento en la nube de Catalyst. Con una simple acción de carga, puedes almacenar tus datos de cualquier tipo como objetos en contenedores llamados buckets.
Obtener todos los buckets
Descripción
Esta API te permite obtener todos los detalles disponibles de todos los buckets presentes en Stratus.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.READ
Detalles de la respuesta
La respuesta devolverá los metadatos y detalles de todos los buckets incluyendo su bucket_name, y los detalles del usuario que creó y modificó por última vez el bucket.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"bucket_name": "fsbucket17",
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 05:01 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 05:01 PM",
"bucket_meta": {
"versioning": false,
"caching": {
"status": "Disabled"
},
"encryption": false,
"audit_consent": false
},
"bucket_url": "https://fsbucket17-development.zohostratus.com"
},
{
"bucket_name": "fsbucket16",
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 04:58 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 04:58 PM",
"bucket_meta": {
"versioning": false,
"caching": {
"status": "Disabled"
},
"encryption": true,
"audit_consent": true
},
"bucket_url": "https://fsbucket16-development.zohostratus.com"
},
{
"bucket_name": "fsbucket15",
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 04:57 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 04:57 PM",
"bucket_meta": {
"versioning": true,
"caching": {
"status": "In-Progress"
},
"encryption": false,
"audit_consent": false
},
"bucket_url": "https://fsbucket15-development.zohostratus.com"
}
]
}
Obtener bucket
Descripción
Esta API te permite obtener todos los detalles disponibles de un bucket presente en Stratus. El bucket se referencia por su nombre único de bucket.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/{bucket_name}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.READ
Detalles de la respuesta
La respuesta devolverá los metadatos y detalles del bucket particular incluyendo su bucket_name, y los detalles del usuario que creó y modificó por última vez el bucket.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket?bucket_name=mybucketname/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"bucket_name": "fsbucket17",
"bucket_url": "https://fsbucket17-development.stratus.com",
"objects_count": 21,
"size_in_bytes": 145578,
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 05:01 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 05:01 PM",
"bucket_meta": {
"versioning": true,
"caching": {
"status": "Enabled"
},
"encryption": true,
"audit_consent": false
}
}
]
}
Obtener todos los objetos
Descripción
Esta API te permite obtener todos los objetos almacenados en un bucket. El bucket se referencia por su nombre único de bucket.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/objects
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.READ
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá una lista de todos los objetos almacenados en el bucket requerido.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/buckets/objects?bucket_name=mybucketname&max_keys=10&continuation_token=Sg43ou34rd2bih223oc8csc&prefix=myfolder/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"key_count": 5,
"max_keys": 5,
"truncated": true,
"next_continuation_token": "n2BjzZo5FvrSQmx7z5LaJk7cvP2Yf2K6AJHw4Sg692TnfwHasUp8DJp8qL24A3TLAGPu8zyEysfjfQpjohEMaej",
"contents": [
{
"key_type": "file",
"key": "server 96.zip",
"version_id": "01hh9hnwxw8r88kzzfnkn67grr",
"size": 3012536,
"content_type": "application/zip",
"etag": "e460808d4190b37c472985a1f1d85720",
"last_modified": "Dec 10, 2023 03:12 PM"
},
{
"key_type": "file",
"key": "oauthscopes.csv",
"version_id": "01hh9hnhypzt63fwf5wyk2ef6f",
"size": 19804,
"content_type": "text/csv",
"etag": "354266606189c30c80f336720102ead6",
"last_modified": "Dec 10, 2023 03:11 PM"
},
{
"key_type": "folder",
"key": "lib 3",
"size": 0,
"last_modified": "Dec 10, 2023 03:11 PM"
},
{
"key_type": "file",
"key": "funcauthtest-Development (1).zip",
"version_id": "01hh9hkv8xvetbxnrhx6c7444y",
"size": 8485,
"content_type": "application/zip",
"etag": "5f868df044e91a4c7e26be26b6e93a64",
"last_modified": "Dec 10, 2023 03:10 PM"
},
{
"key_type": "file",
"key": "Automl_LZ (1).csv",
"version_id": "01hh9hkfdf07y8pnpbwtkt8cf7",
"size": 257,
"content_type": "text/csv",
"etag": "223a363af39a49d4b32f6cdf0c569755",
"last_modified": "Dec 10, 2023 03:10 PM"
}
]
}
}
Obtener un objeto específico
Descripción
Esta API te permite obtener un objeto específico almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Si el versionado está habilitado, entonces el objeto requerido también se puede referenciar usando su version ID único.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.READ
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá los detalles del objeto solicitado.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/{projectID}/bucket/object?bucket_name={bucketName}&version_id={versionID}&object_key={objectPath}
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"key": "Automl_LZ (1).csv",
"size": 257,
"content_type": "text/csv",
"last_modified": "Dec 10, 2023 03:10 PM",
"meta_data": {
"automl_metakey": "metavalue"
},
"object_url": "https://gcpimport2-development.csezstratus.com/Automl_LZ%20(1).csv"
}
}
Obtener todas las versiones de un objeto
Descripción
Esta API te permite obtener todas las versiones del objeto almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/objects/versions
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.READ
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá la lista de detalles de todas las versiones del objeto requerido.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/objects/versions?bucket_name=zylker-bucket&object_key=sampleimage&max_versions=10&continuation_token=Sg43ou34rd2bih223oc8csc/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"truncated": true,
"key": "Automl_LZ (1).csv",
"versions_count": 2,
"max_versions": 2,
"is_truncated": true,
"next_continuation_token": "97tn3xP3te66VpfVwVJwtDAgouBKVNhGAV6jzGY6DMdX6hcJmwJKbFX3unakGdfKfJ",
"version": [
{
"latest": true,
"version_id": "01hh9hkfdf07y8pnpbwtkt8cf7",
"is_latest": true,
"last_modified": "Dec 10, 2023 03:10 PM",
"size": 257,
"etag": "223a363af39a49d4b32f6cdf0c569755"
},
{
"latest": false,
"version_id": "01hh9hjtge85k1fx2yp1kg8r2q",
"is_latest": false,
"last_modified": "Dec 10, 2023 03:10 PM",
"size": 257,
"etag": "223a363af39a49d4b32f6cdf0c569755"
}
]
}
}
Verificar disponibilidad del bucket
Descripción
Esta API te permite verificar la disponibilidad de un bucket particular presente en Stratus. El bucket se referenciará usando su nombre único de bucket
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/{bucket_name}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.READ
Detalles de la respuesta
La respuesta puede ser cualquiera de los siguientes códigos de estado:
- 200: Si el bucket está disponible y si el usuario tiene los permisos relevantes para acceder a él.
- 403: Si el bucket existe, pero el usuario no tiene los permisos relevantes para acceder al bucket.
- 404: Si el bucket no existe.
curl -X HEAD https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket?bucket_name=myBucketName/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
Verificar disponibilidad del objeto
Descripción
Esta API te permite verificar si un objeto particular está almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Si el versionado está habilitado, entonces el objeto requerido también se puede referenciar usando su version ID único.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/objects
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.READ
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el código de estado 200, para indicar que el objeto está presente en el bucket. Si el objeto es incorrecto o no está presente en el bucket, obtendrás un código de estado 404 como respuesta.
curl -X HEAD https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object?bucket_name=myBucketName&object_key=image.jpeg&version_id=dfd233fcds2wd223/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
Descargar objeto
Descripción
Esta API te permite descargar el objeto requerido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{bucket_name}.zohostratus.com/{key}
El nombre de dominio anterior cambiará con respecto al centro de datos:
| DC | Nombre de dominio |
|---|---|
| US | zohostratus.com |
| EU | zohostratus.eu |
| IN | zohostratus.in |
| AU | zohostratus.com.au |
| CA | zohostratus.ca |
| SA | zohostratus.sa |
| JP | zohostratus.jp |
Nota:
-
Si la API se usa en el entorno de desarrollo, entonces el dominio se estructurará de esta manera: https://<bucket_name>-development.zohostratus.com
-
Es aconsejable obtener la URL del bucket desde la consola.
Parámetros de ruta
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
Range: Para descargar un rango de bytes específico de un objeto
retrieve-meta: Para recuperar los metadatos del objeto | Valores posibles: True/False | Valor predeterminado: False
Alcance
Stratus.fileop.READ
Parámetros de consulta para sobrescribir respuestas
Los siguientes parámetros de consulta se pueden agregar para modificar las respuestas y obtener la respuesta requerida. Todos estos son parámetros opcionales. La sobrescritura solo funcionará si la solicitud es exitosa.
attachment; filename=“name”
Ejemplo: attachment; filename=“logo.svg”
Ejemplo: public,max-age=3600,no-transform
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el objeto que será descargado y se mostrará el mensaje de éxito.
Posibles respuestas de error
404 debido a que no se encontró el objeto/bucket:
{
"status": 404,
"code": "key_not_found",
"message": "no such key is associated with any object in the bucket"
}
403 No autorizado. Cuando no tienes los permisos requeridos para realizar la operación de descarga
{
"status": 403,
"code": "access_forbidden",
"message": "request denied by resource access policy"
}
curl -X GET https://{bucket_name}.zohostratus.com/{key}
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
200 OK
// Bytes de datos sin procesar
Cargar objeto
Descripción
Esta API te permite cargar el objeto requerido a un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{bucket_name}.zohostratus.com/{key}
El nombre de dominio anterior cambiará con respecto al centro de datos:
| DC | Nombre de dominio |
|---|---|
| US | zohostratus.com |
| EU | zohostratus.eu |
| IN | zohostratus.in |
| AU | zohostratus.com.au |
| CA | zohostratus.ca |
| SA | zohostratus.sa |
| JP | zohostratus.jp |
Parámetros de ruta
Nota: Los siguientes puntos deben tenerse en cuenta al proporcionar el valor para key:
-
La longitud máxima de la clave (incluyendo el nombre de la ruta y el nombre del objeto) debe ser de solo 255 caracteres.
-
La clave no puede contener los siguientes caracteres incluyendo el espacio: comillas dobles, ambos corchetes angulares, hashtag, barra invertida y símbolo de barra vertical.
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
content-type: application/json
content-length: Longitud sin procesar del objeto que se está cargando en bytes.
compress: Si se debe comprimir el objeto al almacenarlo. Por defecto, la compresión siempre se realiza.
cache-control: Usa este encabezado para especificar las políticas de caché del navegador.
overwrite: Especifica si necesitas sobrescribir un recurso. Esto solo es soportado para los objetos de buckets sin versionado.
expires-after: Esta es una opción que puedes usar para establecer el Time-to-Live (TTL) en segundos para un objeto. El valor debe ser mayor o igual a 60 segundos.
x-user-meta:{1stKey}={1stValue};{2ndKey}={2ndValue};..{NthKey}={NthValue};: Metadatos para el objeto. Cada par clave-valor se separa por punto y coma como se muestra en la columna anterior. 2047 caracteres es la longitud máxima permitida para este encabezado.
Alcance
Stratus.fileop.CREATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el mensaje de éxito y el objeto será cargado.
Posibles respuestas de error
404 debido a que no se encontró el objeto/bucket:
{
"status": 404,
"code": "bucket_not_found",
"message": "no such bucket exists"
}
403 No autorizado. Cuando no tienes los permisos requeridos para realizar la operación de carga
{
"status": 403,
"code": "access_forbidden",
"message": "request denied by resource access policy"
}
400 Solicitud incorrecta. Nombre de archivo inválido
{
"status": 400,
"code": "key_name_invalid",
"message": "key name does not support one or more character(s)"
}
409 Conflicto. Ya existe un objeto con el mismo nombre
{
"status": 409,
"code": "key_already_exists",
"message": "key is already associated with another object in the bucket"
}
curl -X PUT https://{bucket_name}.zohostratus.com/{key}
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
200 OK
Copiar objeto
Descripción
Esta API te permite copiar el objeto requerido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object/copy
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.CREATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el nombre del objeto copiado, la ubicación a donde se copió y el mensaje de éxito confirmando la acción de copia.
curl -X POST https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/copy?bucket_name=myBucketName&object_key=mappedsample/Archive.zip&destination=mappedsample/Unarchive/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"object_key": "image2.png",
"copy_to": "folder2/",
"message": "Copy successful"
}
}
Renombrar objeto
Descripción
Esta API te permite renombrar el objeto requerido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.UPDATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el nombre anterior, el nombre modificado y el mensaje de éxito confirmando la acción de renombrado.
curl -X PATCH https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/?bucket_name=myBucketName¤t_key=image2.png&rename_to=renamed.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"current_key": "image2.png",
"rename_to": "renamed.png",
"message": "Rename successful"
}
}
Agregar metadatos al objeto
Descripción
Esta API te permite agregar metadatos al objeto requerido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Nota:
-
Puedes usar caracteres alfanuméricos, guiones bajos o caracteres de espacio en blanco, así como guiones, para escribir tus metadatos. No se permite ningún otro carácter especial aparte de los mencionados.
-
Puedes obtener los metadatos de un objeto usando el método de solicitud HEAD. En la respuesta, los metadatos se listarán en la clave ‘x-user-meta’.
-
El límite máximo de tamaño de caracteres permitido para los metadatos en general es de 2047 caracteres. El conteo de caracteres usado para determinar el límite de tamaño también incluye el carácter especial dos puntos “:” usado para definir el par clave-valor.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object/metadata
JSON de solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"meta_data": {
"key1": "value1",
"key2": "value2"
}
}
Alimentarás este JSON de solicitud en tu cuerpo de la solicitud, y necesitas proporcionar el valor de:
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.CREATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el mensaje de éxito indicando que los metadatos se han agregado al objeto requerido.
curl -X PUT https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/metadata?bucket_name=myBucketName&object_key=image2.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
--data-raw $’{"{“meta_data” : {“key1” : “value1”,“key2” : “value2”}}"}'
{
"status": "success",
"data": {
"message": "Metadata added successfully"
}
}
Extraer objeto comprimido
Descripción
Esta API te permite extraer un objeto comprimido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object/zip-extract
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.CREATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el nombre del objeto comprimido, el nombre completo de la ruta que almacenó los objetos extraídos y el mensaje de éxito confirmando la acción de extracción.
curl -X POST https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/zip-extract?bucket_name=mybucketname&object_key=image2.png&destination=folder2/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"object_key": "image2.png",
"destination": "folder2",
"message": "Zip extract scheduled",
"task_id": "hh2odww2334nsodno24"
}
}
Obtener estado de la operación de extracción de zip
Descripción
Esta API te permite obtener el estado de una operación de extracción que se está realizando en un objeto comprimido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object/zip-extract/{taskId}
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.READ
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el estado del proceso de extracción requerido que se está realizando en un objeto comprimido en Stratus.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/zip-extract/hh2odww2334nsodno24?bucket_name=mybucketname&object_key=image2.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"task_status": "PENDING | COMPLETED | FAILED"
}
}
Crear firma para el bucket
Descripción
Esta API te permite crear una firma para el bucket requerido. El bucket se referencia por su nombre único de bucket.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/signature
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.CREATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá la firma requerida del bucket junto con su período de tiempo de validez.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bucket/signature?bucket_name=zylker-bucket
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"signature": "stsPolicy=eyJzaWduaW5ndGltZSI6MTcyMTk3NDc1NDQ1MiwiZXhwaXJhdGlvbiI6MzYwMCwiYWN0aW9uIjpbIkdldE9iamVjdCIsIlB1dE9iamVjdCJdLCJjcmVkZW50aWFscyI6IjY3MjUxNjQ0LTg1NDM1OTI2IiwicmVzb3VyY2UiOlsic3JuOjo6dGVzdGRzZHMtZGV2ZWxvcG1lbnQvKiJdLCJxdWVyeSI6W10sImhlYWRlcnMiOltdLCJib2R5Ijp7ImNvbnRlbnQtdHlwZSI6IioiLCJjb250ZW50LWxlbmd0aCI6bnVsbH19&stsSignature=Nyr29x7N-CzDSfFaTzzPnwWsL74ga9rIGZJIxWFdNtI",
"expiry_time": 1786382487000
}
}
Obtener URL prefirmada
Descripción
Esta API te permite obtener URLs prefirmadas. Las URLs prefirmadas son URLs seguras que los usuarios autenticados pueden compartir con sus usuarios no autenticados. Esta URL proporcionará a los usuarios no autenticados autorización temporal para acceder a objetos. Una vez que el enlace expire, necesitas firmar la URL requerida nuevamente usando esta API.
Detalles de la solicitud
URL de solicitud para la acción de carga
{api-domain}/baas/v1/project/{project_id}/bucket/object/signed-url
URL de solicitud para la acción de descarga
{api-domain}/baas/v1/project/{project_id}/bucket/object/signed-url
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance para descarga
ZohoCatalyst.buckets.objects.READ
Alcance para carga
ZohoCatalyst.buckets.objects.CREATE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá la URL prefirmada.
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/signed-url?bucket_name=myBucketName&object_key=object.pdf&expiry_in_seconds=3600&active_from=1716382375000&version_id=bs22sb2923ey2hds929/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
curl -X PUT https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/signed-url?bucket_name=myBucketName&object_key=object.pdf&expiry_in_seconds=3600&active_from=1716382375000/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"signature": "https://mybucket.nimbuspop.com/folder1/folder2/image.jpeg?expires=1642915027000&signature=MEYCIQCcJDTsmZQhfuvFu3l3tsVL02uVwIMhLdlSg~ARI3E1aAIhAJ-rzzjn2gPH9pB3EoU3X~v~qvg5Rdt9OBoldBpVz6xt&key-id=vMUWDURn5DGtokPG",
"expires_in_seconds": 300,
"active_from": 1716382487000
}
}
Eliminar objeto
Descripción
Esta API te permite eliminar el objeto requerido almacenado en un bucket. El bucket se referencia por su nombre único de bucket, y el objeto requerido se referencia usando su nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object/
Parámetros de consulta
JSON de solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"objects": [
{
"key": "file1.jpeg",
"version_id": "{version_id}"
},
{
"key": "file2.jpeg"
},
{
"key": "file3.jpeg"
}
],
"ttl_in_seconds": 100
}
Alimentarás este JSON de solicitud en tu cuerpo de la solicitud, y necesitas proporcionar el valor de:
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.DELETE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el mensaje de éxito confirmando que la operación de eliminación fue exitosa.
curl -X PUT https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object?bucket_name=zylker-bucket/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
--data-raw $’{““status”: “success”,“data”:{“message”: “Deletion successful”}”}'
{
"status": "success",
"data": {
"message": "Deletion successful"
}
}
Eliminar ruta
Descripción
Esta API te permite eliminar una ruta completa y cada objeto almacenado en esa ruta en un bucket. El bucket se referencia por su nombre único de bucket.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/bucket/object/prefix
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.buckets.objects.DELETE
Detalles de la respuesta
Tras la ejecución exitosa, la respuesta contendrá el mensaje de éxito confirmando que la operación de eliminación fue exitosa.
curl -X DELETE https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/prefix?bucket_name=zylker-bucket&prefix=myfolder/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"prefix": "myfolder/",
"message": "Deletion successful"
}
}
File Store
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Catalyst File Store proporciona soluciones de almacenamiento en la nube para almacenar, gestionar y organizar los archivos de tu aplicación y los archivos de datos de usuario como imágenes, videos, archivos CSV, hojas de cálculo y más en carpetas.
Obtener los detalles de una carpeta específica
Descripción
Esta API te permite obtener los detalles de una carpeta específica en el File Store, junto con los detalles de todos los archivos en la carpeta. La carpeta se referencia por su Folder ID único.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.folders.READ
Detalles de la respuesta
La respuesta JSON devuelve los metadatos de la carpeta particular como el folder_name, los detalles del usuario que la creó y la modificó por última vez, junto con los metadatos de todos los archivos en la carpeta, como el file_id, file_name, file_size de cada archivo.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/3376000000427654
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":{
"folder_name":"PricingInfo",
"created_time":"Apr 01, 2020 11:11 AM",
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_id":671930455
},
"modified_time":"Apr 11, 2020 10:41 PM",
"modified_by":{
"zuid":1019540876,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"file_details":[
{
"id":337600000030123,
"file_location":null,
"file_name":"PO1898908GT.pdf",
"file_size":10,
"created_by":{
"zuid":1019540199,
"is_confirmed":true,
"email_id":"jane.simmons@zylker.com",
"first_name":"Jane",
"last_name":"Simmons",
"user_id":671930000
},
"created_time":"Feb 21, 2020 01:11 PM",
"modified_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"modified_time":"Jan 13, 2020 08:00 PM",
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"folder_details": 3376000000427654
},
{
"id":337600000030121,
"file_location":null,
"file_name":"ST1898190CR.pdf",
"file_size":9,
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"created_time":"Jan 01, 2020 09:09 PM",
"modified_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"modified_time":"Mar 11, 2020 07:09 AM",
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"folder_details":3376000000427654
}
],
"audit_consent": false,
"id":829000000038455
}
}
Obtener los detalles de todas las carpetas
Descripción
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Esta API te permite obtener los detalles de todas las carpetas en tu proyecto desde el File Store.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.folders.READ
Detalles de la respuesta
La respuesta JSON devuelve los metadatos de todas las carpetas como el folder_name, los detalles del usuario que la creó y la modificó por última vez, y los detalles del proyecto.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":[
{
"folder_name":"ShipmentOrderForms",
"created_time":"Oct 22, 2019 11:01 AM",
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930455
},
"modified_time": "Jun 05, 2023 12:26 AM",
"modified_by": {
"zuid": 671930455,
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 671930455
},
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"audit_consent": false,
"id":105000000121098
}
{
"folder_name":"PricingInfo",
"created_time":"Sep 01, 2019 03:33 PM",
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671930765
},
"modified_time": "Jun 05, 2023 12:26 AM",
"modified_by": {
"zuid": 671930455,
"is_confirmed": false,
"email_id": "p.boyle@zylker.com",
"first_name": "Patricia",
"last_name": "Boyle",
"user_type": "Admin",
"user_id": 671930765
},
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"audit_consent": false,
"id":105000000145678
}
]
}
Cargar un archivo en una carpeta
Descripción
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Esta API te permite cargar un archivo desde tu sistema local a una carpeta existente en el File Store, haciendo referencia al ID único de la carpeta. Puedes cargar una imagen, documento de texto, CSV o cualquier tipo de archivo que necesites. El tamaño máximo de un archivo que puedes cargar es de 100 MB.
Debes especificar la ruta del archivo y el nombre del archivo en la solicitud de la API, como se muestra en la solicitud de ejemplo.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.files.CREATE
Propiedades JSON de la solicitud
Ruta del archivo a cargar en tu computadora
Tamaño máximo de archivo permitido: 100 MB
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del archivo que fue cargado, como el file_name, file_size, y los detalles del usuario que cargó el archivo.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F code=@/Desktop/EmployeeInfo.csv
-F file_name=EmployeeInfo
{
"status": "success",
"data": {
"id": 56000000368030,
"file_location": null,
"file_name": "EmployeeInfo",
"file_size": 264328,
"created_by": {
"zuid": 1019540152,
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 64635102
},
"created_time": "Jun 05, 2023 12:40 AM",
"modified_by": {
"zuid": 1019540152,
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 64635102
},
"modified_time": "Jun 05, 2023 12:40 AM",
"project_details": {
"project_name": "EmployeePortal",
"id": 3376000001796044,
"project_type": "Live"
},
"folder_details": 3376000001925212
}
}
Descargar un archivo de una carpeta
Descripción
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Esta API te permite descargar un archivo de una carpeta existente en el File Store, haciendo referencia a los IDs únicos de la carpeta y el archivo.
El archivo se descargará automáticamente al directorio configurado en tu sistema después de que ejecutes esta API. Catalyst no enviará ninguna respuesta para esta solicitud.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}/download
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.files.READ
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/332000000044009/download
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
Obtener los detalles de un archivo específico
Descripción
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Esta API te permite obtener los detalles de un archivo específico en una carpeta en el File Store. La carpeta y el archivo se referencian por sus IDs únicos.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.files.READ
Detalles de la respuesta
La respuesta devolverá los metadatos y detalles del archivo particular incluyendo su file_name, file_size, y los detalles del usuario que creó y modificó por última vez el archivo.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/332000000044009
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":{
"id": 332000000044009,
"file_location":null,
"file_name":"Sales2019.csv",
"file_size":264328,
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930111
},
"created_time":"Apr 09, 2020 01:10 AM",
"modified_by":{
"zuid":1019540009,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671930989
},
"modified_time":"Mar 01, 2020 06:18 PM",
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007,
"project_type": "Live"
},
"folder_details":105000000121098
}
}
Obtener los detalles de múltiples archivos
Descripción
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Esta API te permite obtener los detalles de múltiples archivos en una carpeta particular en el File Store. La carpeta se referencia por su Folder ID único.
Esta solicitud de API puede obtener los detalles de un máximo de 200 archivos en la carpeta en una sola llamada. Por lo tanto, si una carpeta tiene 300 archivos, puedes ejecutar una segunda llamada de API para obtener los detalles de los archivos 201 a 300. Esto se puede hacer especificando los valores start y end en los parámetros de consulta en la solicitud como se muestra a continuación. Los primeros 200 archivos se obtienen por defecto, si no se especifican los parámetros de consulta.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file?start={start_index}&end={number_of_files}
Valor de inicio del lote actual
Número de archivos a obtener. El valor máximo permitido es 200.
Por ejemplo, para obtener los detalles de los archivos 201 a 300, especifica el start como ‘201’ y el end como ‘100’.
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.files.READ
Detalles de la respuesta
La respuesta devolverá los metadatos y detalles de todos los archivos que se devuelven, incluyendo su file_name, file_size, y los detalles del usuario que creó y modificó por última vez el archivo.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/3376000000301993/file?start=201&end=2
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data": [
{
"id":3376000000301234,
"file_location":null,
"file_name":"AuditLog.csv",
"file_size":1621,
"created_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930400
},
"created_time":"Apr 27, 2020 07:37 PM",
"modified_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671938657
},
"modified_time":"Apr 27, 2020 07:37 PM",
"project_details": {
"project_name":"ShipmentTracking",
"id": 4000000006007,
"project_type": "Live"
},
"folder_details":3376000000301993
},
{
"id":3376000000300987,
"file_location":null,
"file_name":"ZohoCatalyst-Pricing.pdf",
"file_size":346466,
"created_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Ameila",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930400
},
"created_time":"Apr 27, 2020 07:36 PM",
"modified_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671938657
},
"modified_time":"Apr 27, 2020 07:36 PM",
"project_details": {
"project_name":"ShipmentTracking",
"id":3376000000168765,
"project_type": "Live"
},
"folder_details":3376000000301993
}
]
}
Eliminar un archivo
Para usar el componente Stratus en el modo de Early Access, envíanos un correo electrónico a support@zohocatalyst.com.
Descripción
Esta API se usa para eliminar un archivo existente de una carpeta en el File Store, haciendo referencia al Folder ID y File ID.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.files.DELETE
Detalles de la respuesta
La respuesta devolverá los metadatos y detalles del archivo que fue eliminado, incluyendo su file_name, file_size, y los detalles del usuario que creó y modificó por última vez el archivo.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/4000000044001
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
{
"status": "success",
"data": {
"id": 4000000044001,
"file_location": null,
"file_name": "bookingsSept2019.pdf",
"file_size": 458186,
"created_by": {
"zuid": 671787990,
"is_confirmed":true,
"user_type": "Admin",
"user_id": 671930400,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"created_time": "2019-03-14T12:35:18+05:30",
"modified_by": {
"zuid": 671787990,
"is_confirmed":true,
"user_type": "Admin",
"user_id": 671930400,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"modified_time": "2019-03-14T12:35:18+05:30",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"folder_details": 105000000121098
}
}
Cache
Catalyst Cache es un componente de almacenamiento en memoria pequeño que te permite almacenar datos a los que tu aplicación de Catalyst accede con frecuencia.
El cache de Catalyst se divide en particiones o unidades de cache llamadas segmentos. Cada segmento almacena elementos de cache en forma de pares clave-valor.
Insertar un par clave-valor en un segmento de cache
Descripción
Esta API te permite insertar un par clave-valor como elemento de cache en un segmento de cache. El segmento se identifica por su ID único. La clave representa el atributo y el valor es el dato del elemento de cache.
También puedes especificar opcionalmente el tiempo de expiración del elemento de cache. La validez predeterminada y máxima de un elemento de cache es de dos días.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.cache.CREATE
Propiedades JSON de la solicitud
Tamaño máximo: 50 caracteres
Tamaño máximo: 16000 caracteres
Tamaño máximo: 48
Detalles de la respuesta
La respuesta devolverá los detalles del elemento de cache como cache_name, cache_value y expires_in, junto con los detalles del segmento en el que se insertó.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/3376000000425030/cache
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“cache_name”:“counter”,
“cache_value”:“125”,
“expiry_in_hours”:24
}’
{
"status": "success",
"data": {
"cache_name": "counter",
"cache_value": "125",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"segment_details": {
"id": 3376000000425030,
"segment_name": "CustomerLocation"
},
"expires_in": "Mar 28, 2019 02:03 AM",
"expiry_in_hours": 24,
"ttl_in_milliseconds": 86400000
}
}
Obtener el valor de una clave de cache
Descripción
Esta API te permite recuperar el valor de un elemento de cache de un segmento en el cache. El segmento se identifica por su ID único de segmento, y debes pasar la clave del elemento de cache en la solicitud.
Esta API te permite insertar un par clave-valor como elemento de cache en un segmento de cache. El segmento se identifica por su ID único. La clave representa el atributo y el valor es el dato del elemento de cache.
También puedes especificar opcionalmente el tiempo de expiración del elemento de cache. La validez predeterminada y máxima de un elemento de cache es de dos días.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache?cacheKey={cache_key}
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.cache.READ
Detalles de la respuesta
La respuesta devolverá los detalles del elemento de cache como cache_name, cache_value y expires_in, junto con los detalles de su segmento.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/31000000006023/cache?cacheKey=counter
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"cache_name": "counter",
"cache_value": "1344",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"segment_details": {
"id": 31000000006023,
"segment_name": "MailCounters"
},
"expires_in": "2019-03-13T18:36:02+05:30",
"expiry_in_hours": 3,
"ttl_in_milliseconds": 81187000
}
}
Actualizar un par clave-valor
Descripción
Esta API te permite actualizar un par clave-valor en un segmento de cache. El segmento se identifica por su ID único. La clave representa el atributo y el valor es el dato del elemento de cache.
Puedes actualizar la clave, el valor o el tiempo de expiración del elemento de cache. La validez predeterminada y máxima de un elemento de cache es de dos días.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.cache.CREATE
Propiedades JSON de la solicitud
Tamaño máximo: 50 caracteres
Tamaño máximo: 16000 caracteres
Tamaño máximo: 48
Detalles de la respuesta
La respuesta devolverá los detalles del elemento de cache actualizado como cache_name, cache_value y expires_in, junto con los detalles de su segmento.
curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/3376000000425030/cache
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“cache_name”:“counter”,
“cache_value”:“1472”
}’
{
"status": "success",
"data": {
"cache_name": "counter",
"cache_value": "1472",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"segment_details": {
"id": 3376000000425030,
"segment_name": "CounterValues"
},
"expires_in": "Mar 28, 2019 02:03 AM",
"expiry_in_hours": 7,
"ttl_in_milliseconds": 172800000
}
}
ZCQL
ZCQL es el lenguaje de consulta propio de Catalyst que te permite realizar operaciones de obtención, inserción, actualización y eliminación de datos en las tablas del Catalyst Data Store.
Puedes ejecutar una variedad de consultas DML usando ZCQL para obtener o manipular datos, y usar varias cláusulas y sentencias como las cláusulas SQL Join, sentencias Groupby y OrderBy, y funciones SQL integradas.
Ejecutar una consulta ZCQL
Descripción
Esta API te permite ejecutar una consulta ZCQL para obtener, insertar, actualizar o eliminar datos de las tablas en el Data Store. Puedes ejecutar esta API pasando una consulta ZCQL en la solicitud JSON, como se muestra en las solicitudes de ejemplo.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/query
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.zcql.CREATE
Propiedades JSON de la solicitud
Detalles de la respuesta
Operaciones de obtención de datos: La API devuelve los registros que se obtuvieron como resultado de la ejecución de la consulta como respuesta.
Operaciones de inserción y actualización de datos: La API devuelve los registros que fueron insertados o actualizados a través de la consulta como respuesta.
Operaciones de eliminación de datos: La API devuelve la cantidad de filas eliminadas.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“query”:“SELECT EmpID, EmpName, Department, Address from EmpDetails ORDER BY EmpID ASC LIMIT 1000,5”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-05 15:09:33:881",
"CREATEDTIME": "2023-06-05 15:09:33:881",
"ROWID": "3376000001924975",
"EmpID": "1001",
"EmpName": "Allison Powell",
"Department":"Marketing",
"Address": "13, Winter Avenue, Philadelphia, PY"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-05 15:09:33:881",
"CREATEDTIME": "2023-06-05 15:09:33:881",
"ROWID": "3376000001927682",
"EmpID": "1002",
"EmpName": "James Cortez",
"Department":"HR",
"Address": "25, Blossom Street, Austin, TX"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-02 21:04:11:111",
"CREATEDTIME": "2023-06-02 15:05:21:001",
"ROWID": "3376000001224112",
"EmpID": "1003",
"EmpName": "Han Chan",
"Department":"Sales",
"Address": "112, St.Patrick's Road, Louisville, KY"
}
},
{
"EmpDetails": {
"CREATORID": "337600000003111",
"MODIFIEDTIME": "2023-06-02 21:04:11:111",
"CREATEDTIME": "2023-06-02 15:05:21:001",
"ROWID": "3376000001242012",
"EmpID": "1004",
"EmpName": "Rubella Miguel",
"Department":"Accounts",
"Address": "333, Marine Bay, Salt Lake City, UT"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000115254",
"MODIFIEDTIME": "2023-04-12 21:04:10:521",
"CREATEDTIME": "2023-06-11 15:05:02:541",
"ROWID": "3376000001241341",
"EmpID": "1005",
"EmpName": "Ronwick Boseman",
"Department":"Support",
"Address": "61, Gringott's Avenue, Herfordshire, CO"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“INSERT INTO EmpDetails VALUES (1007,‘Randy Marsh’,‘Sales’,‘42, Tenth Street, Jacksonville, FL’, ‘14 MAR 2017’)”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3813000000002003",
"EmpID": "1007",
"EmpName": "Randy Marsh",
"Department":"Sales",
"Address": "42, Tenth Street, Jacksonville, FL",
"DOJ": "14 MAR 2017",
"MODIFIEDTIME": "2021-08-04 09:10:14:752",
"CREATEDTIME": "2021-08-04 09:10:14:752",
"ROWID": "3813000000214001"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“UPDATE EmpDetails SET Department=‘Operations’ WHERE EmpID=1007”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3813000000002003",
"EmpID": "1007",
"EmpName": "Randy Marsh",
"Department":"Operations",
"Address": "42, Tenth Street, Jacksonville, FL",
"DOJ": "14 MAR 2017",
"MODIFIEDTIME": "2021-08-04 09:11:54:318",
"CREATEDTIME": "2021-08-04 09:10:14:752",
"ROWID": "3813000000214001"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“DELETE FROM EmpDetails WHERE EmpID=1007”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"DELETED_ROWS_COUNT": 1
}
}
]
}
Eliminar un par clave-valor
Descripción
Esta API te permite eliminar un par clave-valor existente de un segmento de cache especificado. El segmento se identifica por su ID único. La clave representa el atributo y el valor es el dato del elemento de cache.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache?cacheKey={cache_key}
Parámetros de consulta
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.cache.DELETE
Detalles de la respuesta
La respuesta devolverá los detalles del elemento de cache eliminado, incluyendo cache_name, cache_value y expires_in. Dado que la entrada de cache ha sido eliminada, tanto cache_value como los campos de expiración devolverán null.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/31000000006023/cache?cacheKey=counter
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"cache_name": "NEW",
"cache_value": null,
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007,
"project_type": "Live"
},
"segment_details": {
"segment_name": "MailCounters",
"id": 31000000006023
},
"expires_in": null,
"expiry_in_hours": null,
"ttl_in_milliseconds": null
}
}
Search
Catalyst Search permite la búsqueda de datos en las columnas indexadas de las tablas en tu Catalyst Data Store. Cuando integras Search en tu aplicación, los usuarios finales podrán realizar búsquedas potentes a través de volúmenes de datos en tu Data Store con una sola consulta de búsqueda.
Ejecutar consulta de búsqueda
Descripción
Esta API te permite ejecutar una operación de búsqueda en las columnas indexadas de todas las tablas en el Data Store. Puedes pasar los parámetros de búsqueda en el JSON de la solicitud. Los registros que coinciden con la consulta de búsqueda se obtienen como respuesta.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/search
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.search.READ
Propiedades JSON de la solicitud
Patrón de búsqueda que contiene las palabras clave a buscar
Puedes proporcionar múltiples palabras clave separadas por comas.
Las columnas indexadas a buscar en una tabla
Debes proporcionar esto en el siguiente formato:
{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}
Las columnas a seleccionar y mostrar basándose en la búsqueda
Debes proporcionar esto en el siguiente formato:
{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}
Ordena los registros obtenidos en los resultados de búsqueda de manera ascendente o descendente
Valores permitidos: ASC, DESC
Índice de inicio de una fila donde debe comenzar la búsqueda
Valor predeterminado: 0
El valor de desplazamiento de una fila donde debe terminar la búsqueda
Valor predeterminado: 500
Detalles de la respuesta
La respuesta devuelve los registros que coinciden con la consulta de búsqueda. Se devuelven los detalles de las filas incluyendo sus metadatos como CREATORID y CREATEDTIME, y los nombres de clave de columna y valores.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/search
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“search” : “Mary”,
“search_table_columns” : {
“CustomerInfo”: [
“CustomerName”,
“TrainerName”
]
},
“start”:1000,
“end”:200
}’
{
"status": "success",
"data": {
"CustomerInfo": [
{
"CREATORID": "56000000002003",
"MODIFIEDTIME": "2019-02-08 13:13:44",
"CustomerName": "Mary Johnson",
"TrainerName": "Helena Stewart",
"CustomerID":"PL1213234",
"CREATEDTIME": "2019-02-08 13:13:44"
},
{
"CREATORID": "56000000002003",
"MODIFIEDTIME": "2019-02-08 20:11:10",
"CustomerName": "Mary Palmer",
"TrainerName": "Ronald Wazlib",
"CustomerID":"SY091834",
"CREATEDTIME": "2019-02-08 20:11:10"
},
{
"CREATORID": "56000000002003",
"MODIFIEDTIME": "2019-11-09 10:00:12",
"CustomerName": "Herbert Spielberg",
"TrainerName": "Mary Amber Rogers",
"CustomerID":"AL987627",
"CREATEDTIME": "2019-11-08 00:12:40"
}
]
}
}
Catalyst Mail te permite agregar las direcciones de correo electrónico de tu negocio que se usarán para enviar correos electrónicos a los usuarios finales desde tu aplicación de Catalyst. Puedes configurar direcciones de correo electrónico de dominios públicos o de los dominios propios de tu organización. También puedes usar un cliente de correo electrónico externo de tu elección y configurar sus ajustes SMTP con Catalyst, en lugar de usar el cliente de correo electrónico integrado de Catalyst. Puedes realizar estas configuraciones desde la consola.
Enviar correo electrónico
Descripción
Esta API te permite enviar correos electrónicos desde una dirección de correo verificada a los destinatarios que especifiques, desde tu aplicación de Catalyst.
Catalyst te permite establecer múltiples direcciones de correo electrónico como receptores, y enviar CC, BCC y responder a través de una sola operación de envío de correo. También puedes adjuntar archivos en tu correo electrónico. Los límites máximos soportados para destinatarios de correo electrónico y archivos adjuntos en una sola operación de envío de correo se especifican a continuación:
- To address: 10
- CC: 10
- BCC: 5
- Reply to: 5
- Número de archivos adjuntos: 5
- Tamaño de archivos adjuntos: 15 MB (a través de un solo archivo o múltiples archivos hasta 5 archivos)
Debes pasar las direcciones de correo electrónico del remitente y del receptor, el asunto, el contenido y los archivos adjuntos del correo electrónico como form-data en tu solicitud de API. Las claves a pasar como form-data, junto con valores de ejemplo, se especifican en la sección Propiedades de Form-Data a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/email/send
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.email.CREATE
Propiedades de Form-Data
Detalles de la respuesta
La respuesta devuelve los detalles del correo electrónico que fue enviado, como el estado del correo enviado, los detalles del proyecto, from_email, to_email y content.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/email/send
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW” \
-F from_email=emma@zylker.com \
-F to_email=vanessa.hyde@zoho.com,r.owens@zoho.com,chang.lee@zoho.com
-F cc=p.boyle@zylker.com,robert.plant@zylker.com
-F bcc=ham.gunn@zylker.com,rover.jenkins@zylker.com
-F reply_to=peter.d@zoho.com,arnold.h@zoho.com
-F attachments=kycform.pdf
-F subject=“Greetings from Zylker Corp!”
-F content="
Hello,
We’re glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address. We cannot wait to get started!
Cheers!
Team Zylker
"
-F html_mode=true
-F display_name=“Amelia Burrows” \
{
"status": "success",
"data": {
"isAsync": false,
"project_details": {
"project_name": "Onboarding",
"id": 2648000000235047,
"project_type": "Live"
},
"display_name": "Amelia Burrows",
"from_email": "emma@zylker.com",
"to_email": [
"vanessa.hyde@zoho.com",
"r.owens@zoho.com",
"chang.lee@zoho.com"
],
"cc": [
"p.boyle@zylker.com",
"robert.plant@zylker.com"
],
"bcc": [
"ham.gunn@zylker.com",
"rover.jenkins@zylker.com"
],
"html_mode": true,
"subject": "Greetings from Zylker Corp!",
"content": "<p>Hello,</p><p>We're glad to welcome you at Zylker Corp. To begin your journey with us, please download thattached KYC form and fill in your details. You can send us the completed form to this same email address. We cannowait to get started!<p>Cheers!</p><p>Team Zylker </p>",
"reply_to": [
"peter.d@zoho.com",
"arnold.h@zoho.com"
]
}
}
Push Notifications
Las push notifications son notificaciones remotas que un proveedor de aplicaciones puede enviar a los usuarios de su aplicación, incluso cuando la aplicación no se está ejecutando activamente en el dispositivo del usuario. Catalyst te proporciona una forma sencilla de integrar push notifications en tus aplicaciones web e iOS de Catalyst.
Enviar Push Notifications Web
Descripción
Esta API se utiliza para enviar push notifications de texto a los usuarios de tu aplicación web para pruebas, después de habilitar las push notifications para ella. Puedes habilitar las push notifications y también registrar dispositivos cliente para recibir push notifications implementando el script web mencionado en esta página de ayuda del Web SDK. Luego puedes usar esta API para enviar push notifications.
Puedes pasar el mensaje de la push notification y una lista de los destinatarios en tu solicitud de API como se muestra en la solicitud de ejemplo.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/project-user/notify
Encabezados de solicitud
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.notifications.web.CUSTOM
Propiedades JSON de la solicitud
Detalles de la respuesta
La respuesta devuelve el estado de la notificación enviada como success o failed.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/notify
-H “Content-Type: application/json”
-d ‘{
“recipients”:[“rhonda.wilkins@zylker.com”,“isabella.j@zylker.com”,“harry.sandman@zylker.com”],
“message”:“Attention, new employees! Update your profile information in Zylker team app”
}’
{
"status": "success",
"data": true
}
Enviar Push Notifications de iOS
Descripción
Esta API se utiliza para enviar push notifications de texto a los dispositivos de los usuarios desde tu aplicación iOS para pruebas, después de registrar tu aplicación con Apple, inscribirte en las push notifications de Catalyst y registrar tu dispositivo. Debes implementar los seis pasos explicados en la sección de ayuda de Push Notifications- iOS antes de poder enviar push notifications a los dispositivos.
Catalyst te permite enviar push notifications ya sea a dispositivos de prueba registrados o a dispositivos de producción pasando el valor de appID desde el archivo de configuración del entorno correspondiente. La URL de solicitud para enviar push notifications a dispositivos de prueba y a dispositivos de producción varía. Estas se presentan en la sección de Detalles de la solicitud.
Puedes pasar el mensaje de la push notification y el destinatario al que deseas enviar las push notifications, junto con otros detalles en tu solicitud de API como se muestra en la solicitud de ejemplo.
Detalles de la solicitud
URL de solicitud para enviar notificaciones de prueba
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/test
URL de solicitud para enviar notificaciones de producción
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/project-user/notify
Encabezados de solicitud
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.notifications.mobile.CUSTOM
Propiedades JSON de la solicitud
El JSON que contiene los detalles del contenido y los metadatos de la push notification
Tamaño máximo: 100 caracteres
Tamaño máximo: 100 caracteres
Detalles de la respuesta
La respuesta devuelve el estado de la notificación enviada como success o failed, y los datos que se pasaron incluyendo message y expiry_time.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/204000000024010/push-notification/204000000036005/project-user/notify
-H “Content-Type: application/json”
-d ‘{
“recipients”:“amanda.boyle@zylker.com”,
“push_details”:{
“message”:“Welcome to Zylker App!”,
“badge_count”:10,
“expiry_time”:12,
“additional_info”:{
“sample_key” : “sample_value”
}
}
}’
{
"status": "success",
"data": {
"recipients": "amanda.boyle@zylker.com",
"push_details": {
"message": "Welcome to Zylker App!",
"additional_info": {
"sample_key": "sample_value"
},
"badge_count": 10,
"reference_id": null,
"expiry_time": 12
}
}
}
Send Push Notifications- Node.js SDK
Send Push Notifications- Python SDK
Register Device for Push Notifications- iOS SDK
Register Device for Push Notifications- Android SDK
Register Device for Push Notifications- Flutter SDK
Register Device for Push Notifications- Web SDK
Enviar Push Notifications de Android
Descripción
Esta API se utiliza para enviar push notifications de texto a los dispositivos de los usuarios desde tu aplicación Android para pruebas, después de registrar tu aplicación con Firebase Cloud Messaging, inscribirte en las push notifications de Catalyst y registrar tu dispositivo. Debes implementar los cuatro pasos explicados en la sección de ayuda de Push Notifications- Android antes de poder enviar push notifications.
Catalyst te permite enviar push notifications ya sea a dispositivos de prueba registrados o a dispositivos de producción pasando el valor de appID desde el archivo de configuración del entorno correspondiente. La URL de solicitud para enviar push notifications a dispositivos de prueba y a dispositivos de producción varía. Estas se presentan en la sección de Detalles de la solicitud.
Puedes pasar el mensaje de la push notification y el destinatario al que deseas enviar las push notifications, junto con otros detalles en tu solicitud de API como se muestra en la solicitud de ejemplo.
Detalles de la solicitud
URL de solicitud para enviar notificaciones de prueba
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/test
URL de solicitud para enviar notificaciones de producción
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/project-user/notify
Parámetros de consulta
isAndroid: true
Encabezados de solicitud
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.notifications.mobile.CUSTOM
Propiedades JSON de la solicitud
El JSON que contiene los detalles del contenido y los metadatos de la push notification
Tamaño máximo: 100 caracteres
Tamaño máximo: 100 caracteres
Detalles de la respuesta
La respuesta devuelve el estado de la notificación enviada como success o failed, y los datos que se pasaron incluyendo message y expiry_time.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/204000000024010/push-notification/204000000036005/project-user/notify?isAndroid=true
-H “Content-Type: application/json”
-d ‘{
“recipients”:“amanda.boyle@zylker.com”,
“push_details”:{
“message”:“Welcome to Zylker App!”,
“badge_count”:10,
“expiry_time”:12,
“additional_info”:{
“sample_key” : “sample_value”
}
}
}’
{
"status": "success",
"data": {
"recipients": "amanda.boyle@zylker.com",
"push_details": {
"message": "Welcome to Zylker App!",
"additional_info": {
"sample_key": "sample_value"
},
"badge_count": 10,
"reference_id": null,
"expiry_time": 12
}
}
}
Send Push Notifications- Node.js SDK
Send Push Notifications- Python SDK
Register Device for Push Notifications- iOS SDK
Register Device for Push Notifications- Android SDK
Register Device for Push Notifications- Flutter SDK
Register Device for Push Notifications- Web SDK
Optical Character Recognition
Zia Optical Character Recognition detecta electrónicamente caracteres textuales en imágenes o documentos digitales, y los convierte en texto codificado por máquina. Zia OCR puede reconocer texto en 10 idiomas principales.
Ejecutar OCR
Descripción
Esta API se usa para detectar caracteres textuales en imágenes y documentos, y entregar el texto reconocido como una respuesta JSON. La respuesta también contiene una puntuación de confianza, que define la precisión de la detección.
Debes especificar la ruta al archivo de imagen o documento en la solicitud de la API, como se muestra en la solicitud de ejemplo. Opcionalmente puedes especificar los idiomas presentes en el texto, para un procesamiento más rápido. OCR soporta 9 idiomas internacionales y 10 idiomas indios, que se mencionan en las tablas a continuación. El idioma se detecta automáticamente y el texto se procesa, si no se especifica.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/ocr
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
El archivo de entrada a procesar. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png, .bmp, .tiff, .pdf
Límite de tamaño de archivo: 20 MB
Idiomas Internacionales Soportados por OCR
| Idioma | Códigos de Idioma |
|---|---|
| Arabic | ara |
| Chinese | chi_sim |
| French | fra |
| Italian | ita |
| Japanese | jpn |
| Portuguese | por |
| Romanian | ron |
| Spanish | spa |
Idiomas Indios Soportados por OCR
| Idioma | Códigos de Idioma |
|---|---|
| English | eng |
| Hindi | hin |
| Bengali | ben |
| Marathi | mar |
| Telugu | tel |
| Tamil | tam |
| Gujarati | guj |
| Urdu | urd |
| Kannada | kan |
| Malayalam | mal |
| Sanskrit | san |
Detalles de la Respuesta
La respuesta devuelve los data del procesamiento OCR, que incluyen el texto reconocido de la entrada en la clave text y la puntuación de confianza del reconocimiento en la clave confidence.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “image=/Desktop/HelplineCard.webp”
-F “language=eng,spa”
{
"status":"success",
"data": {
"confidence":79.71514892578125,
"text":"Whenever you\nneed to talk,\nwe're open\n\n[—] text eseses\n[J] KidsHelpPhone.ca\n\n(@, call 1—800—663—6868 Kids Help Phone ©"
}
}
AutoML
Zia AutoML te permite entrenar modelos y analizar un conjunto de datos de entrenamiento para predecir el resultado de un subconjunto de esos datos. Puedes construir y entrenar modelos de Binary Classification, Multi-Class Classification y Regression, y obtener informes de evaluación detallados.
Ejecutar AutoML
Descripción
Esta API se usa para pasar datos de entrada para la predicción de un modelo AutoML como pares clave-valor. Debes pasar los datos en formato JSON en la solicitud como se describe a continuación.
Nota:
- El modelo AutoML ya debe estar creado. Puedes crear y configurar un modelo desde la consola.
- Puedes especificar la columna objetivo, o la columna en el conjunto de datos cuyo valor necesita ser predicho, mientras configuras el modelo desde la consola.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/automl/model/{model_id}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Formato del JSON de Solicitud
Debes enviar los nombres de columna y los valores de columna correspondientes en formato JSON de esta manera:
{
“column1_name”: “column1_value”,
“column2_name”: “column2_value”,
“column3_name”: “column3_value”
}
donde column_name es una clave en el conjunto de datos requerida para predecir el objetivo, y column_value es el dato que proporcionas para la columna correspondiente.
Nota:
-
Si ingresas un valor en un formato que no coincide con el tipo de dato de la columna, como un valor numérico para el tipo fecha, el valor no será analizado. Asegúrate de proporcionar los datos en el formato correcto.
-
Debes proporcionar el valor para al menos una columna válida al probar la predicción.
-
Si no ingresas el valor para un campo de entrada, Zia ingresará automáticamente un valor predeterminado para la columna. Sin embargo, esto afectará la precisión de la predicción.
Detalles de la Respuesta
La respuesta devuelve los data del procesamiento OCR, que incluyen el texto reconocido de la entrada en la clave text y la puntuación de confianza del reconocimiento en la clave confidence.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/automl/model/105000000124001
-H “Authorization: Zoho-oauthtoken 1000.8cb99d**********************9be93.9b8***********************f”
-H “Content-Type: application/json”
-d ‘{
“country”: “Armenia”,
“year”: “2016”,
“sex”: “female”,
“age”: “25-34”,
“population”: “277452”,
“GDP_for_year”: “10,546,135,160”
}’
{
"status":"success",
"data":{
"regression_result":3.41
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/automl/model/105000000124001
-H “Authorization: Zoho-oauthtoken 1000.8cb99d********************9be93.9b8********************f”
-H “Content-Type: application/json”
-d ‘{
“year_film”: “2019”,
“year_award”: “2020”,
“ceremony”: “77”,
“category”: “Best Director - Motion Picture”,
“nominee”: “Todd Phillips”,
“film”: “Joker”
}’
{
"status":"success",
"data":{
"classification_result": {
"True":20,
"False":80
}
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/automl/model/105000000124001
-H “Authorization: Zoho-oauthtoken 1000.8cb99d******************9be93.9b8******************f”
-H “Content-Type: application/json”
-d ‘{
“Transaction_date”: “1/2/09 4:53”,
“Product”: “RAM”,
“Price”: “120”,
“City”: “Parkville”,
“State”: “MO”,
“Country”: “United States”,
“Account_Created”: “12/4/08 4:42”,
“Last_Login”: “1/2/09 7:49”
}’
{
"status":"success",
"data":{
"classification_result": {
"Amex":10,
"Diner":20,
"Mastercard": 30,
"Visa":40
}
}
}
Face Analytics
Zia Face Analytics realiza detección facial en imágenes y analiza las características faciales para proporcionar información como el género, la edad y la emoción de los rostros detectados.
Face Analytics también proporciona los niveles de confianza de cada predicción de atributo que te permiten tomar decisiones informadas. Puede detectar hasta 10 rostros en una imagen y proporciona predicciones de los atributos para cada rostro detectado.
Ejecutar Face Analytics
Descripción
Puedes usar esta API para realizar detección y análisis facial en un archivo de imagen, y especificar la ruta al archivo en la solicitud de la API como se muestra en la solicitud de ejemplo.
Opcionalmente puedes especificar un modo de análisis que determina la cantidad de puntos de referencia faciales a detectar en un rostro. También puedes habilitar o deshabilitar los atributos a predecir, como la emoción, la edad y el género.
Esta API se usa para pasar datos de entrada para la predicción de Face Analytics. Debes pasar un archivo de imagen de entrada y los datos en formato JSON en la solicitud como se describe a continuación.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/faceanalytics
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
El archivo de entrada a procesar. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png
Límite de tamaño de archivo: 10 MB
Indica la cantidad de puntos de referencia faciales a detectar en un rostro
Valores permitidos: basic, moderate, advanced
Valor predeterminado: advanced
- basic: Detector de 0 puntos de referencia que detecta solo el contorno del rostro
- moderate: Detector de 5 puntos de referencia que detecta- Ojos: El centro de ambos ojos, Nariz: Punta de la nariz, Labios: El centro de ambos labios
- advanced: Detector de 68 puntos de referencia que detecta- Línea de mandíbula: Contorno del rostro, Cejas: Ceja izquierda y derecha, Ojos: Ojo izquierdo y derecho, Puente nasal, Línea de fosas nasales, Labio superior: Borde superior e inferior, Labio inferior: Borde superior e inferior
Valores permitidos:
false: La emoción no será detectada
true: La emoción será detectada
Valor predeterminado: true
Valores permitidos:
false: La edad no será detectada
true: La edad será detectada
Valor predeterminado: true
Valores permitidos:
false: El género no será detectado
true: El género será detectado
Valor predeterminado: true
Detalles de la Respuesta
La respuesta devuelve los detalles de los puntos de referencia faciales de los rostros detectados, y las predicciones de emoción, edad y género, basadas en los parámetros y modo establecidos en la solicitud de la API en la clave data.
La probabilidad general de las coordenadas de la detección de puntos de referencia faciales, y la probabilidad de las predicciones realizadas para los parámetros de emoción, edad y género se devolverán como puntuaciones de confidence.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/faceanalytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “basic”,
“emotion”: “true”,
“age”: “true”,
“gender”: “true”
}’
{
"status": "success",
"data": {
"faces": [
{
"confidence": 1.0,
"id": 0,
"co_ordinates": [
267,
39,
153,
227
],
"emotion": {
"prediction": "not_smiling",
"confidence": {
"smiling": "0.0",
"not_smiling": "1.0"
}
},
"age": {
"prediction": "3-9",
"confidence": {
"0-2": "0.005",
"10-19": "0.33",
"20-29": "0.12",
"3-9": "0.509",
"30-39": "0.032",
"40-49": "0.003",
"50-59": "0.0",
"60-69": "0.0",
">70": "0.0"
}
},
"gender": {
"prediction": "female",
"confidence": {
"female": "0.92",
"male": "0.08"
}
}
}
]
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/faceanalytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “moderate”,
“emotion”: “false”,
“age”: “false”,
“gender”: “true”
}’
{
"status": "success",
"data": {
"faces": [
{
"confidence": 1.0,
"id": 0,
"co_ordinates": [
267,
39,
153,
227
],
"landmarks": {
"left_eye": [337,135],
"right_eye": [400,130],
"nose": [
400,
165
],
"mouth_left": [
353,
217
],
"mouth_right": [
404,
211
]
},
"gender": {
"prediction": "female",
"confidence": {
"female": "0.92",
"male": "0.08"
}
}
}
]
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/faceanalytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “advanced”,
“emotion”: “true”,
“age”: “false”,
“gender”: “false”
}’
{
"status": "success",
"data": {
"faces": [
{
"co_ordinates" : [ 185, 96, 275, 18],
"confidence" : 0.99
"landmarks" : {
'mouth': [
[259, 440],
[287, 423],
[312, 413],
[325, 418],
[338, 414],
[354, 424],
[368, 442],
[355, 461],
[339, 470],
[325, 472],
[310, 470],
[285, 460],
[269, 440],
[311, 435],
[324, 436],
[338, 436],
[359, 442],
[339, 440],
[326, 441],
[312, 439]
],
'right_eyebrow': [
[189, 245],
[216, 230],
[244, 227],
[273, 234],
[301, 248]
],
'left_eyebrow': [
[356, 249],
[379, 238],
[401, 232],
[422, 235],
[436, 252]
],
'right_eye': [
[225, 288],
[245, 281],
[265, 282],
[280, 295],
[263, 297],
[244, 297]
],
'left_eye': [
[358, 299],
[376, 288],
[393, 290],
[408, 298],
[393, 305],
[376, 304]
],
'nose': [
[329, 287],
[331, 311],
[334, 336],
[337, 360],
[301, 385],
[315, 389],
[329, 392],
[341, 390],
[352, 385]
],
'jaw': [
[131, 283],
[136, 340],
[145, 393],
[158, 442],
[180, 484],
[212, 513],
[250, 530],
[287, 542],
[319, 545],
[347, 535],
[370, 512],
[393, 487],
[411, 456],
[423, 419],
[432, 381],
[437, 342],
[439, 303]
]
},
"emotion": {
"prediction": "not_smiling",
"confidence": {
"smiling": "0.0",
"not_smiling": "1.0"
}
}
}
]
}
}
Image Moderation
Zia Image Moderation detecta y reconoce contenido inapropiado e inseguro en imágenes. Los criterios incluyen contenido sugestivo o explícitamente subido de tono, desnudez, violencia, gore, derramamiento de sangre, y la presencia de armas y drogas.
Ejecutar Image Moderation
Descripción
Esta API reconoce el siguiente contenido inapropiado en imágenes y lo devuelve en la respuesta: racy, weapon, nudity, gore, drug. La respuesta también contiene la probabilidad de cada criterio con sus puntuaciones de confianza, y la predicción de la imagen como safe_to_use o unsafe_to_use.
Debes especificar la ruta de la imagen en la solicitud de la API, como se muestra en la solicitud de ejemplo. También puedes establecer opcionalmente el modo de moderación para la solicitud.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/imagemoderation
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
El archivo de entrada a procesar.
Formatos permitidos: .webp, .jpeg, .png, .txt
Límite de tamaño de archivo: 10 MB
Indica el modo de moderación
Valores permitidos: basic, moderate, advanced
Valor predeterminado: advanced
- basic: Detecta solo desnudez
- moderate: Detecta desnudez y contenido subido de tono
- advanced: Detecta todos los criterios mencionados en la descripción
Detalles de la Respuesta
La respuesta contendrá la probabilidad de los parámetros detectados, basada en el modo establecido en la solicitud de la API. Basándose en un agregado de los parámetros detectados, también incluirá la prediction de la imagen como segura o insegura para usar, junto con una puntuación de confidence de la predicción.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/imagemoderation
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “basic”
}’
{
"probability": {
"nudity": "1.0"
},
"confidence": 1,
"prediction": "unsafe_to_use"
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/imagemoderation
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “moderate”
}’
{
"probability": {
"racy": "0.0",
"nudity": "0.0"
},
"confidence": 0.9,
"prediction": "safe_to_use"
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/imagemoderation
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “advanced”
}’
{
"probability": {
"racy": "0.0",
"weapon": "1.0",
"nudity": "0.0",
"gore": "0.0",
"drug": "0.0"
},
"confidence": 1,
"prediction": "unsafe_to_use"
}
Object Recognition
Zia Object Recognition detecta, localiza y reconoce objetos individuales en un archivo de imagen. Puede identificar 80 tipos diferentes de objetos comunes en imágenes. Zia puede reconocer 80 tipos específicos de objetos, algunos de los cuales incluyen: persona, automóvil, perro, silla, semáforo, cuchillo, paraguas y teléfono celular.
Ejecutar Object Recognition
Descripción
Esta API se usa para detectar, localizar y reconocer objetos individuales en un archivo de imagen. La respuesta devuelve las coordenadas de cada objeto detectado en la imagen, su tipo y la puntuación de confianza de cada reconocimiento.
Debes especificar la ruta al archivo de imagen en la solicitud de la API, como se muestra en la solicitud de ejemplo.
Detalles de la Solicitud
URL de Solicitud
http://api.catalyst.zoho.com/baas/v1/project/{project_id}/ml/detect-object
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
El archivo de imagen que será procesado para el reconocimiento de objetos. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png, .txt
Límite de tamaño de archivo: 10 MB
Detalles de la Respuesta
La respuesta contendrá los detalles de cada objeto individual detectado, que incluyen sus co_ordinates, object_type y la puntuación de confidence de la detección.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/56000000405001/ml/detect-object
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt” \
{
"status":"success",
"data":{
"objects":[
{
"co_ordinates":[
37,
94,
704,
434
],
"object_type":"dog",
"confidence":"98.92"
},
{
"co_ordinates":[
20,
67,
202,
120
],
"object_type":"umbrella",
"confidence":"97.05"
}
]
}
}
Barcode Scanner
Zia Barcode Scanner te permite escanear los formatos de códigos de barras lineales y 2D más comúnmente utilizados y decodificar los datos codificados. Barcode Scanner puede detectar formatos como Codabar, EAN-13, ITF, UPC-A, QR Code y más.
Ejecutar Barcode Scanner
Descripción
Esta API se usa para decodificar los datos codificados en un código de barras a partir de un archivo de imagen. Debes especificar la ruta al archivo de imagen en la solicitud de la API, como se muestra en la solicitud de ejemplo.
Opcionalmente puedes especificar el formato del código de barras. Si no lo especificas, Catalyst procesará automáticamente el valor predeterminado all para este campo. La respuesta JSON devuelve los datos decodificados.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/barcode
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
El archivo de entrada con el código de barras a escanear.
Formatos permitidos: .webp, .jpeg, .png, .txt
Límite de tamaño de archivo: 10 MB
Límite de resolución: 36000000 píxeles
El formato del código de barras en la imagen. Los códigos de formato se especifican en la tabla a continuación.
Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png
Límite de tamaño de archivo: 10 MB
Códigos de Formato de Código de Barras
| Formato de Código de Barras | Código de Formato |
|---|---|
| Code 39 | code39 |
| Code 128 | code128 |
| Code 93 | code93 |
| Ean 8 | ean8 |
| Ean 13 | ean13 |
| Codabar | codabar |
| ITF | itf |
| UPC-A | upca |
| UPC-E | upce |
| RSS | rss |
| QR code | qrcode |
| Aztec | aztec |
| PDF417 | pdf417 |
| Data Matrix | datamatrix |
| Si no conoces el formato o si no lo especificas |
all |
Detalles de la Respuesta
La respuesta contendrá los datos detectados en el código de barras en el campo content.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“format”: “ITF”
}’
{
"status": "success",
"data": {
"content": "40156"
}
}
Identity Scanner
Identity Scanner es un componente impulsado por IA de Zia que te permite realizar verificaciones de identidad seguras en individuos y documentos mediante el escaneo y procesamiento de varias identificaciones oficiales o documentos oficiales. Es un conjunto integral que incorpora múltiples funcionalidades divididas en dos categorías principales: E-KYC y Document Processing.
Facial Comparison
Facial Comparison, también conocido como E-KYC, es una parte de Identity Scanner que compara dos rostros en dos imágenes diferentes para determinar si son el mismo individuo.
Procesar Facial Comparison
Descripción
Esta API te permite realizar una comparación facial entre una imagen de origen y una imagen de consulta. Debes especificar las rutas a ambos archivos de imagen en la solicitud de la API, como se muestra en la solicitud de ejemplo.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/facecomparison
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
La identificación con foto o la fotografía de un individuo. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png
Límite de tamaño de archivo: 10 MB
La identificación con foto o la fotografía de un individuo. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png
Límite de tamaño de archivo: 10 MB
Detalles de la Respuesta
La respuesta devuelve el resultado de la comparación como true si los rostros coinciden, o false si no coinciden.
La respuesta también contiene una puntuación de confianza entre el rango de 0 a 1. Solo si la comparación produce una puntuación de confianza superior al 50%, es decir, 0.5, el resultado se establecerá como true.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/facecomparison
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F source_image=/Desktop/SourceImage.webp
-F query_image=/Desktop/QueryImage.webp
{
"status": "success",
"data": {
"confidence": 1.0,
"matched": "true"
}
}
Aadhaar
El modelo AADHAAR es parte de la funcionalidad de Document Processing de Identity Scanner que te permite procesar tarjetas Aadhaar indias como documentos de prueba de identidad.
Nota:
-
Catalyst no almacena ninguno de los archivos que subes en sus sistemas. Los documentos que subes se utilizan solo para procesamiento único. Tampoco se utilizan para propósitos de entrenamiento de modelos ML. Los componentes de Catalyst cumplen completamente con todas las leyes aplicables de protección de datos y privacidad.
-
Document Processing solo es relevante para usuarios indios y está disponible únicamente en el DC de IN. Esta funcionalidad no estará disponible para usuarios que acceden desde los centros de datos EU, AU, US, JP, SA o CA. Los usuarios fuera de India desde los otros DCs pueden acceder al componente OCR general para leer y procesar contenido textual.
Procesar Aadhaar
Descripción
Esta API extrae campos de datos de una tarjeta Aadhaar india usando una tecnología OCR avanzada. La respuesta JSON devolverá los parámetros reconocidos de la tarjeta Aadhaar, junto con puntuaciones de confianza para cada reconocimiento que determinan su precisión. Debes proporcionar la ruta a los archivos de imagen del frente y reverso de la tarjeta Aadhaar, y especificar el tipo de modelo como AADHAAR en la solicitud de la API.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/ocr
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
La imagen del lado frontal de la tarjeta Aadhaar a procesar. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png, .bmp, .tiff
Límite de tamaño de archivo: 15 MB
La imagen del lado posterior de la tarjeta Aadhaar a procesar. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png, .bmp, .tiff
Límite de tamaño de archivo: 15 MB
El tipo de modelo de la imagen
Valor a pasar: AADHAAR
El código de idioma del idioma a identificar. El modelo AADHAAR soporta los idiomas indios listados en la tabla a continuación.
Debes pasar inglés y el idioma regional relevante solamente para el tipo AADHAAR. Por ejemplo, si eres de Tamil Nadu, debes pasar tam y eng en la solicitud.
Idiomas Soportados por el Tipo de Modelo Aadhaar
| Idioma | Códigos de Idioma |
|---|---|
| English | eng |
| Hindi | hin |
| Bengali | ben |
| Marathi | mar |
| Telugu | tel |
| Tamil | tam |
| Gujarati | guj |
| Urdu | urd |
| Kannada | kan |
| Malayalam | mal |
| Sanskrit | san |
Detalles de la Respuesta
La respuesta contiene los parámetros reconocidos en la tarjeta Aadhaar como el nombre del titular de la tarjeta, dirección, género, número de tarjeta Aadhaar asignados a las claves respectivas. La respuesta también muestra una puntuación de confianza en el rango de 0 a 1 para cada uno de los valores reconocidos.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F aadhaar_front=/Desktop/Aadhaar1.webp
-F aadhaar_back=/Desktop/Aadhaar2.webp
-F model_type=AADHAAR
-F “language=eng,tam”
{
"status":"success",
"data":{
"text": "{\"address\":{\"prob\":0.5,\"value\":\"S/O Tony, Seer 40, S/O Julie, 40, Dewdrops Street, Cherry Hill Pondicherry, Pondicherry ureing4Gen, ureing4Gen 605008 \"},\"gender\":{\"prob\":\"0.9\",\"value\":\"male\"},\"dob\": {\"prob\":\"0.6\", \"value\":\"12/12/2012\"},\"name\":{\"prob\":\"0.8\", \"value\":\"Hari Krishnan\"},\"aadhaar\":{\"prob\":0.8,\"value\":\"1234 5678 0123\"}}"
}
}
PAN
El modelo PAN es parte de la funcionalidad de Document Processing de Identity Scanner que te permite procesar tarjetas PAN indias como documentos de prueba de identidad.
Nota:
-
Catalyst no almacena ninguno de los archivos que subes en sus sistemas. Los documentos que subes se utilizan solo para procesamiento único. Tampoco se utilizan para propósitos de entrenamiento de modelos ML. Los componentes de Catalyst cumplen completamente con todas las leyes aplicables de protección de datos y privacidad.
-
Document Processing solo es relevante para usuarios indios y está disponible únicamente en el DC de IN. Esta funcionalidad no estará disponible para usuarios que acceden desde los centros de datos EU, AU, US, JP, SA o CA. Los usuarios fuera de India desde los otros DCs pueden acceder al componente OCR general para leer y procesar contenido textual.
Procesar PAN
Descripción
Esta API extrae campos de datos de una tarjeta PAN usando una tecnología OCR avanzada, y devuelve los parámetros reconocidos de la tarjeta PAN como una respuesta JSON. Debes proporcionar la ruta al archivo de imagen del lado frontal de la tarjeta PAN que contiene los datos personales en la solicitud de la API. Debes especificar el tipo de modelo en la solicitud de la API como PAN, para procesar la tarjeta PAN. El modelo PAN solo puede procesar texto en inglés de forma predeterminada.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/ocr
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
La imagen del lado frontal de la tarjeta PAN. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png
Límite de tamaño de archivo: 15 MB
El tipo de modelo de la imagen
Valor a pasar: PAN
Detalles de la Respuesta
La respuesta contendrá los parámetros extraídos de la tarjeta PAN como el nombre, apellido, fecha de nacimiento y el número de tarjeta PAN asignados a las claves respectivas.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F image=/Desktop/MyPan.webp
-F model_type=PAN
{
"status": "success",
"data": {
"first_name": "KIRAN",
"last_name": "RAO",
"date_of_birth": "03/04/1982",
"pan": "ANRPM2537J"
}
}
Passbook
El modelo PASSBOOK es parte de la funcionalidad de Document Processing de Identity Scanner que te permite procesar libretas bancarias indias como documentos financieros o de prueba de identidad.
Nota:
-
Catalyst no almacena ninguno de los archivos que subes en sus sistemas. Los documentos que subes se utilizan solo para procesamiento único. Tampoco se utilizan para propósitos de entrenamiento de modelos ML. Los componentes de Catalyst cumplen completamente con todas las leyes aplicables de protección de datos y privacidad.
-
Document Processing solo es relevante para usuarios indios y está disponible únicamente en el DC de IN. Esta funcionalidad no estará disponible para usuarios que acceden desde los centros de datos EU, AU, US, JP, SA o CA. Los usuarios fuera de India desde los otros DCs pueden acceder al componente OCR general para leer y procesar contenido textual.
Procesar Passbook
Descripción
Esta API extrae campos de datos de una libreta bancaria usando la tecnología OCR y devuelve los parámetros reconocidos de la libreta como una respuesta JSON. Debes proporcionar la ruta al archivo de imagen de la primera página de la libreta bancaria, y especificar el tipo de modelo como PASSBOOK en la solicitud de la API.
También puedes opcionalmente ingresar los idiomas presentes en la libreta en la solicitud de la API. El proceso de reconocimiento y extracción de texto es más rápido y preciso si especificas los idiomas.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/ocr
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
La imagen de la primera página de la libreta bancaria. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png, .bmp, .tiff, .pdf
Límite de tamaño de archivo: 15 MB
El tipo de modelo de la imagen
Valor a pasar: PASSBOOK
El código de idioma de los idiomas a identificar. Puedes pasar múltiples idiomas. El modelo PASSBOOK soporta los idiomas indios e internacionales especificados en las tablas a continuación.
Valor predeterminado: eng
Idiomas Internacionales Soportados por el Tipo de Modelo Passbook
| Idioma | Códigos de Idioma |
|---|---|
| English | eng |
| Arabic | ara |
| Chinese | chi_sim |
| French | fra |
| Italian | ita |
| Japanese | jpn |
| Portuguese | por |
| Romanian | ron |
| Spanish | spa |
Idiomas Indios Soportados por el Tipo de Modelo Passbook
| Idioma | Códigos de Idioma |
|---|---|
| Hindi | hin |
| Bengali | ben |
| Marathi | mar |
| Telugu | tel |
| Tamil | tam |
| Gujarati | guj |
| Urdu | urd |
| Kannada | kan |
| Malayalam | mal |
| Sanskrit | san |
Detalles de la Respuesta
La respuesta contiene los datos bancarios y los datos de cuenta reconocidos de la libreta, como el nombre del banco, sucursal, dirección, número de cuenta. Los campos de información extraídos se asignan a sus claves respectivas. La respuesta también muestra si RTGS, NEFT e IMPS han sido habilitados para esa cuenta devolviendo true o false para esas claves.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F image=/Desktop/MyPassbook.pdf
-F model_type=PASSBOOK
-F “language=eng”
{
"status":"success",
"data":{
"text": "{\"address\":\"NO.20 ,SUNSHINE LANE,ANNA NAGAR,CHENNAI\",\"city\":\"CHENNAI\",\"centre\":\"CHENNAI\",\"bankName\":\"ABC BANK LIMITED\",\"accountNumber\":\"000000001111222\",\"branch\":\"ANNA NAGAR\",\"dateOfOpening\":\"30/08/2012\",\"imps\":\"true\",\"neft\":\"true\",\"district\":\"CHENNAI\",\"contact\":\"2891289\",\"micr\":\"0101010\",\"name\":\" 999919\",\"state\":\"TAMIL NADU\",\"rtgs\":\"true\",\"ifsc\":\"ABCB0000111\"}"
}
}
Cheque
El modelo CHEQUE es parte de la funcionalidad de Document Processing de Identity Scanner que te permite procesar hojas de cheques bancarios indios como documentos de prueba de identidad.
Nota:
-
Catalyst no almacena ninguno de los archivos que subes en sus sistemas. Los documentos que subes se utilizan solo para procesamiento único. Tampoco se utilizan para propósitos de entrenamiento de modelos ML. Los componentes de Catalyst cumplen completamente con todas las leyes aplicables de protección de datos y privacidad.
-
Document Processing solo es relevante para usuarios indios y está disponible únicamente en el DC de IN. Esta funcionalidad no estará disponible para usuarios que acceden desde los centros de datos EU, AU, US, JP, SA o CA. Los usuarios fuera de India desde los otros DCs pueden acceder al componente OCR general para leer y procesar contenido textual.
Procesar Cheque
Descripción
Esta API extrae campos de datos de un cheque usando una tecnología OCR avanzada, y devuelve los parámetros reconocidos del cheque como una respuesta JSON. Debes proporcionar la ruta al archivo de imagen de una hoja de cheque en la solicitud de la API, y especificar el tipo de modelo como CHEQUE en la solicitud de la API.
El modelo CHEQUE solo puede procesar texto en inglés de forma predeterminada. No se soportan otros idiomas.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/ocr
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
La imagen de una hoja de cheque bancario. Debes proporcionar la ruta en tu sistema local.
Formatos permitidos: .webp, .jpeg, .png
Límite de tamaño de archivo: 15 MB
El tipo de modelo de la imagen
Valor a pasar: CHEQUE
Detalles de la Respuesta
La respuesta contendrá los parámetros extraídos del cheque, como el monto, nombre del banco, nombre de la sucursal, número de cuenta, código IFSC, asignados a las claves respectivas.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F image=/Desktop/MyCheque.webp
-F model_type=CHEQUE \
{
"status": "success",
"data": {
"amount": "50000",
"branch_name": "ANNA NAGAR WEST",
"bank_name": "STATE BANK OF INDIA",
"account_number": "00001234556001",
"ifsc": "SBIN0011724",
"date": "25/09/2012"
}
}
Text Analytics
Text Analytics en su conjunto incluye una combinación de las siguientes tres funcionalidades: Sentiment Analysis, Named Entity Recognition y Keyword Extraction. Puedes realizar las tres acciones en un bloque de texto específico, y obtener el tono del texto, las categorizaciones de las entidades reconocidas en él, y palabras y frases clave que proporcionan un resumen del texto.
Ejecutar All Text Analytics
Descripción
Puedes usar esta API para realizar Sentiment Analysis, Named Entity Recognition y Keyword Extraction en un bloque de texto de hasta 1500 caracteres. Puedes pasar el texto en el cuerpo JSON de la solicitud, como se muestra en la solicitud de ejemplo.
También puedes pasar palabras clave opcionales para realizar Sentiment Analysis solo en las oraciones que contienen esas palabras clave.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
Detalles de la Respuesta
La respuesta contiene los resultados de cada funcionalidad de text analytics. Consulta la sección de detalles de respuesta de cada funcionalidad individualmente para obtener información detallada.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“document”:"[Zoho Corporation is an Indian software development company. The focus of Zoho Corporation lies in web-based business tools and information technology.]"
}’
{
"status":"success",
"data":[
{
"keyword_extractor":{
"keywords":[
"focus"
],
"keyphrases":[
"Indian software development company",
"Zoho Corporation",
"web - based business tools",
"information technology"
]
},
"sentiment_prediction":[
{
"document_sentiment":"Neutral",
"sentence_analytics":[
{
"sentence":"Zoho Corporation is an Indian software development company.",
"sentiment":"Neutral",
"confidence_scores":{
"negative":0.0,
"neutral":1.0,
"positive":0.0
}
},
{
"sentence":"The focus of Zoho Corporation lies in web-based business tools and information technology.",
"sentiment":"Neutral",
"confidence_scores":{
"negative":0.0,
"neutral":1.0,
"positive":0.0
}
}
],
"overall_score":1.0
}
],
"ner":{
"general_entities":[
{
"start_index":0,
"confidence_score":99,
"end_index":16,
"ner_tag":"Organization",
"token":"Zoho Corporation"
},
{
"start_index":23,
"confidence_score":99,
"end_index":29,
"ner_tag":"Miscellaneous",
"token":"Indian"
},
{
"start_index":73,
"confidence_score":99,
"end_index":89,
"ner_tag":"Organization",
"token":"Zoho Corporation"
}
]
}
}
]
}
Sentiment Analysis
Zia Sentiment Analysis es una parte de Text Analytics que procesa contenido textual para reconocer el tono del mensaje y los sentimientos transmitidos a través de él. Analiza cada oración en el texto para determinar si su tono es Positive, Negative o Neutral. Luego determina el tono del texto general como uno de estos tres sentimientos, basándose en los sentimientos reconocidos en cada oración.
La respuesta también devuelve las puntuaciones de confianza para cada oración y el texto general, para mostrar la precisión del análisis.
Ejecutar Sentiment Analysis
Descripción
Puedes usar esta API para realizar Sentiment Analysis en un bloque de texto de hasta 1500 caracteres en una sola solicitud. Debes pasar el texto en el cuerpo JSON de la solicitud, como se muestra en la solicitud de ejemplo.
También puedes pasar palabras clave opcionales para el texto. Esto permitirá que Sentiment Analysis procese solo aquellas oraciones que contienen estas palabras clave, y determine sus sentimientos. Las demás oraciones serán ignoradas.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics/sentiment-analysis
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
Detalles de la Respuesta
La respuesta contiene el resultado del análisis individual de cada oración y el análisis del texto general como Positive, Negative o Neutral, junto con la puntuación de confianza general de cada análisis. La puntuación de confianza se encuentra en el rango de 0 a 1.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics/sentiment-analysis
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{“document”:"[I love the design of the new model.]",
“keywords”:"[design]"
}’
{
"status":"success",
"data":[
{
"sentiment_prediction":[
{
"document_sentiment":"Positive",
"sentence_analytics":[
{
"sentence":"I love the design of the new model",
"sentiment":"Positive",
"confidence_scores":{
"negative":0.0,
"neutral":0.0,
"positive":1.0
}
}
],
"keyword":"design",
"overall_score":1.0
}
]
}
]
}
Named Entity Recognition
Zia Named Entity Recognition es una parte de Text Analytics que procesa contenido textual para extraer palabras clave y agruparlas en varias categorías. Por ejemplo, puede determinar que una palabra en un texto es el nombre de una organización, el nombre de una persona o una fecha, y agregarla a la categoría apropiada en consecuencia. Consulta aquí para ver una lista de todas las categorías reconocidas por NER.
La respuesta devolverá los detalles de todas las entidades reconocidas, y una etiqueta indicando la categoría a la que pertenecen. También contendrá la puntuación de confianza de cada reconocimiento para mostrar su precisión, y las ubicaciones de la entidad en el texto.
Ejecutar Named Entity Recognition
Descripción
Puedes usar esta API para realizar named entity recognition en un bloque de texto de hasta 1500 caracteres en una sola solicitud. Puedes pasar el texto en el cuerpo JSON de la solicitud, como se muestra en la solicitud de ejemplo.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics/ner
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
Detalles de la Respuesta
La respuesta devuelve un array de todas las entidades reconocidas en el texto. Los detalles de cada reconocimiento de entidad contienen la etiqueta de la categorización de la entidad, como ORG oMISC para indicar el nombre de una organización o un valor misceláneo respectivamente.
La respuesta también devuelve la ubicación de cada entidad en el texto a través de start_index y end_index, que indican los índices de inicio y fin de la entidad. La puntuación de confianza determinada para cada clasificación de entidad se representa en valores porcentuales.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics/ner
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“document”:"[The biggest reason for me to love and remember this trek is the beautiful valley itself. Right from the entry, you can see a bed of pink alpine orchids, blue Himalayan poppies, yellow marigolds, and a whole variety of flowers spread out around you. The weather was also very pleasant that day, about 24 degree celsius, which made the experience all the more amazing.]"
}’
{
"status": "success",
"data": [
{
"ner": {
"general_entities": [
{
"start_index": 21,
"confidence_score": 100,
"end_index": 25,
"ner_tag": "Color",
"token": "pink"
}
]
}
},
{
"ner": {
"general_entities": [
{
"start_index": 94,
"confidence_score": 56,
"end_index": 97,
"ner_tag": "Duration",
"token": "day"
}
]
}
},
{
"ner": {
"general_entities": []
}
},
{
"ner": {
"general_entities": []
}
},
{
"ner": {
"general_entities": [
{
"start_index": 0,
"confidence_score": 100,
"end_index": 6,
"ner_tag": "Color",
"token": "yellow"
}
]
}
},
{
"ner": {
"general_entities": [
{
"start_index": 6,
"confidence_score": 100,
"end_index": 15,
"ner_tag": "Temperature",
"token": "24 degree",
"fine_entities": [
{
"start_index": 9,
"end_index": 15,
"ner_tag": "Fahrenhiet",
"token": "degree"
},
{
"start_index": 6,
"end_index": 8,
"ner_tag": "Value",
"token": "24"
}
]
},
{
"start_index": 16,
"confidence_score": 100,
"end_index": 23,
"ner_tag": "Unit_temperature",
"token": "celsius"
}
]
}
},
{
"ner": {
"general_entities": [
{
"start_index": 5,
"confidence_score": 61,
"end_index": 14,
"ner_tag": "Miscellaneous",
"token": "Himalayan"
},
{
"start_index": 0,
"confidence_score": 100,
"end_index": 4,
"ner_tag": "Color",
"token": "blue"
}
]
}
}
]
}
Keyword Extraction
Zia Keyword Extraction es una parte de Text Analytics que procesa contenido textual y extrae los aspectos destacados del texto. Los términos extraídos se agrupan en dos categorías: Keywords y Keyphrases. Estos aspectos destacados entregan un resumen conciso del texto y proporcionan una abstracción del texto completo.
Keyword Extraction es una funcionalidad muy útil si deseas revisar rápidamente contenido textual extenso y obtener solo la información esencial y los puntos de acción. Podrás identificar fácilmente el tema y la esencia del texto a partir de la respuesta, y ahorrar tiempo valioso.
Ejecutar Keyword Extraction
Descripción
Puedes usar esta API para realizar Keyword Extraction en un bloque de texto de hasta 1500 caracteres en una sola solicitud. Puedes pasar el texto en el cuerpo JSON de la solicitud, como se muestra en la solicitud de ejemplo.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics/keyword-extraction
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.mlkit.READ
Propiedades del JSON de Solicitud
Detalles de la Respuesta
La respuesta contiene un array de las palabras clave y otro array de las frases clave que se extraen del texto.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics/keyword-extraction
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“document”:
“[Catalyst is a full-stack cloud-based serverless development tool, that provides backend functionalities to build applications and microservices on various platforms.]”
}’
{
"status": "success",
"data": [
{
"keyword_extractor": {
"keywords": [
"microservices",
"applications"
],
"keyphrases": [
"backend functionalities",
"various platforms"
]
}
},
{
"keyword_extractor": {
"keywords": [
"Catalyst"
],
"keyphrases": [
"cloud-based serverless development tool"
]
}
}
]
}
Automation Testing
Automation Testing es una herramienta de pruebas de API que automatiza el proceso de pruebas de las APIs en tu aplicación. Puedes probar las funciones Basic I/O y Advanced I/O en tu aplicación, o cualquier URL de terceros, y obtener respuestas. Puedes escribir casos de prueba según tus requisitos, programar pruebas para que se ejecuten automáticamente y gestionar todo el proceso de pruebas de API con una intervención manual mínima.
Ejecutar un plan de pruebas
Descripción
Un plan de pruebas permite la ejecución automatizada de uno o más conjuntos de pruebas en Automation Testing. Esta API te permite activar la ejecución de un plan de pruebas que ya está configurado en la consola remota de tu proyecto. Esto es equivalente a la opción de ejecución instantánea disponible para un plan de pruebas en la consola.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/automation-testing/{test_plan_id}/execute
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Environment: Development
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.automationtesting.execute
Detalles de la respuesta
La respuesta contiene el estado de la ejecución del plan de pruebas, junto con detalles como el Run ID único que se generará para cada ejecución automatizada o instantánea del plan de pruebas, el Test Plan ID que se pasó, y el parámetro is_schedule_started que contiene el estado del inicio de la ejecución como true o false.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3359000000016812/automation-testing/537000000022025/execute
-H “Authorization: Zoho-oauthtoken 1000.25*************************e.3e*************************3” \
{
"status": "success",
"data": {
"id": 537000000034053,
"test_plan_id": 537000000022025,
"is_schedule_started": true
}
}
Catalyst SmartBrowz
Catalyst SmartBrowz es un servicio de navegador de Catalyst que te permite gestionar y controlar un navegador remoto en el entorno cloud de Catalyst a través de una amplia gama de componentes. Estos incluyen Browser Grid, la función Browser Logic, PDF & Screenshot, Templates y más.
Browser Grid
Browser Grid es un componente de Catalyst SmartBrowz que te permite conectarte a navegadores headless a través de configuraciones personalizadas de Nodos y Navegadores.
Listar Todos los Browser Grids
Descripción
Puedes usar esta API para obtener una lista de todos los grids que se han creado para tu proyecto.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Detalles de la Respuesta
Recibirás una respuesta que contiene los detalles de todos los grids presentes en el proyecto.
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid'
-H ‘CATALYST-ORG: 111737956’
-H ‘Content-Type: application/json’
-H ‘Authorization: Zoho-oauthtoken 1000.******************************************************780’
{
“status”: “success”,
“data”: [
{
“id”: “3970000000006058”,
“name”: “play”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 07:04 PM”,
“modified_time”: “Sep 10, 2025 07:04 PM”,
“api_key_modified_time”: “1757511270919”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 1,
“max_session_count”: 1,
“max_nodes_count”: 10,
“max_concurrent_count”: 10,
“config_type”: 1
},
{
“id”: “3970000000005426”,
“name”: “Automation”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 12:47 PM”,
“modified_time”: “Sep 23, 2025 03:12 PM”,
“api_key_modified_time”: “1757488669690”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 2,
“max_session_count”: 1,
“max_nodes_count”: 5,
“max_concurrent_count”: 5,
“config_type”: 2
},
{
“id”: “3970000000005027”,
“name”: “SDK”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 11:33 AM”,
“modified_time”: “Sep 10, 2025 04:27 PM”,
“api_key_modified_time”: “1757484201284”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 2,
“max_session_count”: 1,
“max_nodes_count”: 5,
“max_concurrent_count”: 5,
“config_type”: 1
},
{
“id”: “3970000000005015”,
“name”: “Puppeteer_Grid”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 10:21 AM”,
“modified_time”: “Sep 10, 2025 10:21 AM”,
“api_key_modified_time”: “1757479864798”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 1,
“max_session_count”: 1,
“max_nodes_count”: 1,
“max_concurrent_count”: 1,
“config_type”: 1
},
{
“id”: “3970000000005013”,
“name”: “Selenium_Gridt”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 10:21 AM”,
“modified_time”: “Sep 23, 2025 05:50 PM”,
“api_key_modified_time”: “1757479864794”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 2,
“max_session_count”: 1,
“max_nodes_count”: 1,
“max_concurrent_count”: 1,
“config_type”: 2
}
]
}
Listar un Browser Grid Específico
Descripción
Puedes usar esta API para listar los detalles de un browser grid específico creado en tu proyecto. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Detalles de la Respuesta
Recibirás una respuesta que contiene los detalles de un grid específico.
curl -X PUT ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000006058'
-H ‘CATALYST-ORG: 111737956’
-H ‘Connection: keep-alive’
-H ‘Content-Type: application/json’
-H ‘Authorization: Zoho-oauthtoken 1000********************************************780’
-d ‘{
“name”: “grid_2”,
“memory”: 1024,
“max_nodes_count”: 10,
“max_session_count”: 1,
“endpoint_type”: 1,
“config_type”: 1
}’
{
“status”: “success”,
“data”: {
“id”: “3970000000006058”,
“name”: “play2”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 07:04 PM”,
“modified_time”: “Sep 24, 2025 11:55 AM”,
“api_key_modified_time”: “1757511270919”,
“created_by”: {
“zuid”: “111734674”,
“is_confirmed”: false,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“is_confirmed”: false,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 1,
“max_session_count”: 1,
“max_nodes_count”: 10,
“max_concurrent_count”: 10,
“config_type”: 1
}
}
Obtener Estadísticas en Vivo del Grid
Descripción
Puedes usar esta API para obtener estadísticas en vivo del rendimiento de un grid específico. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=live_stats
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene las estadísticas en vivo de un grid específico referenciado usando su Grid ID.
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?data_to_fetch=live_stats'
-H ‘Authorization: Zoho-oauthtoken 1000*************************************f780’
-H ‘CATALYST-ORG: 111737956’
curl -X GET / ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?data_to_fetch=live_stats'
-H ‘api-key: 961***********************************************************************7049’
{
“status”: “success”,
“data”: {
“free_sessions”: 5,
“session_queue_size”: 0,
“node_count”: 0,
“session_count”: 0,
“is_hub_alive”: false
}
}
Obtener Conteo de Nodos y Solicitudes de un Grid
Descripción
Puedes usar esta API para obtener estadísticas del conteo de Nodos y Solicitudes de un grid. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=node_req_count&datetime_filter=Last+30+Days
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene los valores máximos y promedio de las estadísticas de conteo de nodos y solicitudes de un grid específico referenciado usando su Grid ID.
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=node_req_count'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=node_req_count'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: {
“avg_concurrent_node_count”: “1”,
“max_concurrent_node_count”: “1”,
“avg_concurrent_req_count”: “0”,
“max_concurrent_req_count”: “0”
}
}
Obtener Uso de Memoria y CPU de un Grid
Descripción
Puedes usar esta API para obtener los detalles de uso de memoria y CPU de un grid específico. El grid requerido se referencia usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=memory_cpu_usage&datetime_filter=Last+30+Days
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene los valores máximos y promedio de las estadísticas de uso de memoria y CPU de un grid específico referenciado usando su Grid ID.
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=memory_cpu_usage'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
-H ‘catalyst-org: 111737956’
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=memory_cpu_usage'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: {
“max_memory_usage”: 926.65234375,
“high_disk_usage_count”: 0,
“max_cpu_usage”: 1.1011011011011012,
“avg_memory_usage”: 926.65234375,
“avg_cpu_usage”: 1.1011011011011012
}
}
Obtener Estadísticas de Rechazos de Navegador y Caídas de Nodos
Descripción
Puedes usar esta API para obtener las estadísticas de navegadores que fueron rechazados de generarse y nodos que se cayeron en un grid. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=crashed_data&datetime_filter=Last+30+Days
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene el número de navegadores que no se les permitió generarse y nodos que se cayeron de un grid específico referenciado usando su Grid ID.
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=crashed_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’ \
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=crashed_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: {
“browser_req_reject_count”: 0,
“node_crashed_count”: “0”
}
}
Gráfico de Solicitudes de Navegador
Descripción
Puedes usar esta API para obtener datos sobre el número de solicitudes de navegador en el grid durante 24 horas. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=req_graph_data
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene el tiempo y el uso del browser grid durante 24 horas. El grid requerido se referencia usando su Grid ID.
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=req_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=req_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
[“Sep 22 2025, 04:00 PM”, 0.0],
[“Sep 22 2025, 06:00 PM”, 0.0],
[“Sep 22 2025, 08:00 PM”, 0.0],
[“Sep 22 2025, 10:00 PM”, 0.0],
[“Sep 23 2025, 12:00 AM”, 0.0],
[“Sep 23 2025, 02:00 AM”, 0.0],
[“Sep 23 2025, 04:00 AM”, 0.0],
[“Sep 23 2025, 06:00 AM”, 0.0],
[“Sep 23 2025, 08:00 AM”, 0.0],
[“Sep 23 2025, 10:00 AM”, 0.0],
[“Sep 23 2025, 12:00 PM”, 0.0],
[“Sep 23 2025, 02:00 PM”, 0.0],
[“Sep 23 2025, 04:00 PM”, 0.0],
[“Sep 23 2025, 06:00 PM”, 0.0]
]
}
Gráfico de Conteo de Nodos
Descripción
Puedes usar esta API para obtener datos sobre el número de nodos activos en el grid durante 24 horas. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=node_graph_data
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene el tiempo y el conteo de nodos de un browser grid durante 24 horas. El grid requerido se referencia usando su Grid ID.
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=node_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=node_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
[“Sep 23 2025, 11:00 AM”, 0.0],
[“Sep 23 2025, 01:00 PM”, 0.0],
[“Sep 23 2025, 03:00 PM”, 0.0],
[“Sep 23 2025, 05:00 PM”, 1.0],
[“Sep 23 2025, 07:00 PM”, 0.0],
[“Sep 23 2025, 09:00 PM”, 0.0],
[“Sep 23 2025, 11:00 PM”, 0.0],
[“Sep 24 2025, 01:00 AM”, 0.0],
[“Sep 24 2025, 03:00 AM”, 0.0],
[“Sep 24 2025, 05:00 AM”, 0.0],
[“Sep 24 2025, 07:00 AM”, 0.0],
[“Sep 24 2025, 09:00 AM”, 0.0],
[“Sep 24 2025, 11:00 AM”, 0.0],
[“Sep 24 2025, 01:00 PM”, 0.0]
]
}
Gráfico de Uso de Memoria
Descripción
Puedes usar esta API para obtener datos sobre la memoria utilizada por el grid durante 24 horas. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=memory_graph_data
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene el tiempo y el conteo de nodos de un browser grid durante 24 horas. El grid requerido se referencia usando su Grid ID.
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=memory_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=memory_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
{
“time”: “Sep 23 2025, 11:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 01:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 03:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 05:00 PM”,
“memory_usage_mb”: 771.1453125
},
{
“time”: “Sep 23 2025, 07:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 09:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 11:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 01:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 03:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 05:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 07:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 09:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 11:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 01:00 PM”,
“memory_usage_mb”: 0.0
}
]
}
Gráfico de Uso de CPU
Descripción
Puedes usar esta API para obtener datos sobre el CPU utilizado por el grid durante 24 horas. El grid requerido se referenciará usando su Grid ID.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=cpu_graph_data
Alcance
ZohoCatalyst.grid.read
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene el uso de CPU de un browser grid durante 24 horas. El grid requerido se referencia usando su Grid ID.
curl -X GET ‘https://consoleqa2.catalyst.localzoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=cpu_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET ‘https://consoleqa2.catalyst.localzoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=cpu_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
[“Sep 23 2025, 11:00 AM”, 0.0],
[“Sep 23 2025, 01:00 PM”, 0.0],
[“Sep 23 2025, 03:00 PM”, 0.0],
[“Sep 23 2025, 05:00 PM”, 0.8621659781801722],
[“Sep 23 2025, 07:00 PM”, 0.0],
[“Sep 23 2025, 09:00 PM”, 0.0],
[“Sep 23 2025, 11:00 PM”, 0.0],
[“Sep 24 2025, 01:00 AM”, 0.0],
[“Sep 24 2025, 03:00 AM”, 0.0],
[“Sep 24 2025, 05:00 AM”, 0.0],
[“Sep 24 2025, 07:00 AM”, 0.0],
[“Sep 24 2025, 09:00 AM”, 0.0],
[“Sep 24 2025, 11:00 AM”, 0.0],
[“Sep 24 2025, 01:00 PM”, 0.0]
]
}
Detener Browser Grid
Descripción
Puedes usar esta API para detener y terminar efectivamente el browser grid.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stop
Alcance
ZohoCatalyst.grid.terminate
Encabezados de Solicitud para API Usando OAuth
Authorization: Zoho-oauthtoken {oauth_token}
CATALYST-ORG: Proporciona el valor de tu Org ID.
Encabezados de Solicitud para API Usando API Key
Authorization
api-key: La clave única generada por Catalyst. Se puede obtener desde la consola.
Detalles de la Respuesta
Recibirás una respuesta que contiene detalles sobre el estado de la ejecución.
curl -X POST
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stop'
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
-H ‘catalyst-org: 111737956’
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stop'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: true
}
PDF y Captura de Pantalla
PDF & Screenshot es un componente de SmartBrowz que te permite generar documentos visuales de sitios web y aplicaciones web. Es una herramienta poderosa que se puede usar para convertir páginas web a PDF, para usar durante la depuración de UI y para comprender los componentes visuales desde la perspectiva de los usuarios finales, mientras implementas operaciones de rastreo permitidas, por nombrar algunos usos.
Puedes introducir esta funcionalidad en tu aplicación Catalyst usando la API a continuación.
Generar PDF Usando HTML/URL
Descripción del PDF
Puedes usar esta API para generar documentos PDF de páginas web usando código HTML o URL como entrada.
Detalles de la Solicitud del PDF
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/convert
Alcance
ZohoCatalyst.pdfshot.EXECUTE
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Propiedades del JSON de Solicitud
Valor predeterminado: false.
Plantilla HTML para el encabezado de impresión. Debe ser HTML válido con las siguientes clases para inyectar valores en ellas:
El valor predeterminado se puede cambiar usando los métodos
page.set_default_timeout() o page.set_default_navigation_timeout().
Detalles de la Respuesta del PDF
La respuesta devolverá el documento PDF generado.
Generar Captura de Pantalla Usando HTML/URL
Descripción de la Captura de Pantalla
Puedes usar esta API para generar capturas de pantalla de páginas web usando código HTML o URL como entrada.
Detalles de la Solicitud de la Captura de Pantalla
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/convert
Alcance
ZohoCatalyst.pdfshot.EXECUTE
Propiedades del JSON de Solicitud
Detalles de la Respuesta de la Captura de Pantalla
La respuesta devolverá una captura de pantalla que fue generada.
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
–d ‘{
“url”: “https://www.example.com”,
“output_options”: {
“output_type”: “pdf”
},
“pdf_options” : {
“scale” : 1,
“display_header_footer” : true,
“header_template” : “<style> #header, #footer { margin: 0 !important; padding: 0 !important; font-size: 9px; -webkit-print-color-adjust: exact;}</style><div style=\width:100%><span class=\date></span><span class=\title\ style=\float:right></span</div>”,
“footer_template” : “<style> #header, #footer { margin: 0 !important; padding: 0 !important; font-size: 9px; -webkit-print-color-adjust: exact;}</style><div style=\width:100%><span class=\url></span><div style=\float:right><span class=\pageNumber></span> / <span class=\totalPages></span></div></div>”,
“print_background” : false,
“landscape” : false,
“page_ranges” : “1”,
“format” : “A4”,
“width” : “100”,
“height” : “100”,
“margin” :
{
“top” : “1cm”,
“bottom” : “1cm”,
“left” : “1cm”,
“right”: “1cm”
},
“omit_background” : false
},
“page_options”:{
“css” : {
“content” : “body{background: lightgrey}”
},
“viewport” : {
“width”: 1440,
“height”: 900
},
“javascript_enabled” : true
},
“navigation_options”:{
“timeout” : 5000,
“wait_until” : “networkidle0”
}
}’
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
–d’{
“url”: “https://www.example.com”,
“output_options”: {
“output_type”: “screenshot”
},
“screenshot_options”: {
“type”: “jpeg”,
“quality”: 100,
“full_page”: false,
“omit_background”: false,
“capture_beyond_viewport”: true,
“clip”: {
“x”: 50,
“y”: 100,
“width”: 1000,
“height”: 100
}
},
“page_options”: {
“css”: {
“content”: “body{background: lightgrey}”
},
“viewport”: {
“width”: 1440,
“height”: 900
},
“javascript_enabled”: true
},
“navigation_options”: {
“timeout”: 5000,
“wait_until”: “networkidle0”
}
}’
Generar PDF Usando Plantillas
Descripción
Puedes usar esta API para generar documentos PDF de páginas web usando Templates como entrada.
Detalles de la Solicitud del PDF
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/convert
Alcance
ZohoCatalyst.pdfshot.EXECUTE
Propiedades del JSON de Solicitud
Valor predeterminado: false.
El valor predeterminado se puede cambiar usando los métodos
page.set_default_timeout() o page.set_default_navigation_timeout().
Detalles de la Respuesta del PDF
La respuesta será un PDF que fue generado.
Nota:
-
Necesitas crear una plantilla en la consola para usar esta API.
-
SmartBrowz Templates te ofrece la opción de establecer una contraseña para el documento PDF que generas usando una plantilla. Si empleas la opción Set Password Manually, entonces puedes usar esta API. Esta API no se puede usar si empleas la opción Set Password Dynamically.
Generar Captura de Pantalla Usando Plantillas
Descripción de la Captura de Pantalla
Puedes usar esta API para generar capturas de pantalla de páginas web, usando Templates como entrada.
Detalles de la Solicitud de la Captura de Pantalla
URL de Solicitud
{api-domain}/browser360/v1/project/{project_id}/convert
Alcance
ZohoCatalyst.pdfshot.EXECUTE
Propiedades del JSON de Solicitud
El valor predeterminado se puede cambiar usando los métodos
page.set_default_timeout() o page.set_default_navigation_timeout().
Detalles de la Respuesta de la Captura de Pantalla
La respuesta será una captura de pantalla que fue generada.
curl -X POST 'https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
–d ‘{
“template_id”:“367000000044001”,
“template_data”:{},
“output_options”: {
“output_type”: “pdf”
},
“pdf_options” : {
“scale” : 1,
“display_header_footer” : true,
"print_background" : false,
"landscape" : false,
"page_ranges" : "1",
"format" : "A4",
"width" : "100",
"height" : "100",
"omit_background" : false,
"password": "Demo$"
},
"page_options":{
"css" : {
"content" : "body{background: lightgrey}"
},
"viewport" : {
"width": 1440,
"height": 900
},
"javascript_enabled" : true
},
"navigation_options":{
"timeout" : 5000,
"wait_until" : "networkidle0"
}
}’
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
-d ‘{
“template_id”:“367000000044001”,
“template_data”:{},
“output_options”: {
“output_type”: “pdf”
},
“screenshot_options” : {
“type” : “jpeg”,
“quality” : 100,
“full_page” : false,
“omit_background” : false,
“capture_beyond_viewport” : true,
“clip” :{
“x” : 50,
“y” : 100,
“width” : 1000,
“height”: 100
}
},
“page_options”:{
"css" : {
"content" : "body{background: lightgrey}"
},
"viewport" : {
"width": 1440,
"height": 900
},
"javascript_enabled" : true
},
“navigation_options”:{
“timeout” : 5000,
“wait_until” : “networkidle0”
}
}’
Catalyst ConvoKraft
Catalyst ConvoKraft es un servicio impulsado por IA que te permite construir chatbots inteligentes y desplegarlos en tus aplicaciones de Catalyst. Estos bots aprovechan la Comprensión del Lenguaje Natural (NLU) para interpretar mensajes y responder naturalmente en inglés conversacional. Puedes personalizar el bot configurando tu propia lógica, proporcionando pares simples de pregunta-respuesta, o entrenándolo con recursos personalizados, según los requisitos de tu aplicación.
SmartTrain es un componente del servicio Catalyst ConvoKraft que te permite entrenar tu chatbot usando tus propios recursos. Puedes hacer esto configurando URLs web donde están alojados los recursos. Esto permite que el bot proporcione rápidamente respuestas precisas a las consultas de los usuarios relacionadas con el contenido entrenado.
Puedes consultar esta documentación de ayuda para obtener más información sobre el servicio Catalyst ConvoKraft.
Habilitar o deshabilitar SmartTrain
Esta API habilita o deshabilita SmartTrain en el servicio Catalyst ConvoKraft. Cuando está habilitado, puedes agregar materiales de entrenamiento para mejorar las respuestas del bot. Deshabilitarlo pausa temporalmente el conocimiento entrenado del bot, evitando que responda consultas basadas en los datos de entrenamiento. Una vez rehabilitado, el entrenamiento se restaura automáticamente, permitiendo que el bot responda usando los materiales cargados previamente.
Puedes introducir esta funcionalidad en tu aplicación de Catalyst usando la API a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/convokraft/api/v1/bots/{botid}? type=DEVELOPED
Nota:
-
El parámetro de consulta type=DEVELOPED se usa para indicar que el bot está en estado de desarrollo dentro del servicio ConvoKraft.
-
Puedes obtener el botid directamente desde la URL en el servicio ConvoKraft cuando el entorno está configurado en Development en la consola.
Por ejemplo : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
Aquí, 3828281991118 es el botid.
Scope
ZIAPlatform.Convokraft.RAG.UPDATE
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
Propiedades JSON de la solicitud
Pasa el valor como true para habilitar la función RAG y false para deshabilitarla.
Predeterminado: true.
Detalles de la respuesta
La respuesta devolverá el estado de la operación de habilitar o deshabilitar SmartTrain, junto con un mensaje de estado y código de estado.
curl -X PATCH
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’
--data ‘{
“bots”: {
“is_rag_enabled”: true
}
}’
{
"status": "SUCCESS",
"code": "SUCCESS",
"message": "Updated Successfully."
}
Agregar material de entrenamiento
Esta API te permite cargar materiales de entrenamiento personalizados a SmartTrain, permitiendo que el bot de ConvoKraft se entrene automáticamente. Puedes proporcionar URLs web de los materiales de entrenamiento alojados en cualquier plataforma de terceros en formato HTML o TXT. Una vez cargados, el bot procesa el contenido y lo usa para responder a consultas relevantes.
Puedes introducir esta funcionalidad en tu aplicación de Catalyst usando la API a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
Nota:
-
El parámetro de consulta type=DEVELOPED se usa para indicar que el bot está en estado de desarrollo dentro del servicio ConvoKraft.
-
Puedes obtener el botid directamente desde la URL en el servicio ConvoKraft cuando el entorno está configurado en Development en la consola.
Por ejemplo : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
Aquí, 3828281991118 es el botid.
Scope
ZIAPlatform.Convokraft.RAG.CREATE
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
Propiedades JSON de la solicitud
Detalles de la respuesta
Esta API proporciona el estado del proceso de carga del material de entrenamiento, incluyendo el código de estado y el mensaje. También devuelve las URLs de los materiales cargados junto con un ID único asignado por ConvoKraft para cada URL.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’
--data ‘{
“rag_training_data”: [
{
“url”: “https://www.apple.com/iphone-15”,
“title”: “Iphone 15 Specifications”
},
{
“url”: “https://www.apple.com/iphone-11/”,
“title”: “Iphone 11 Specifications”
}
]
}’
{
"status": "SUCCESS",
"code": "SUCCESS",
"message": "File upload in progress",
"info": {
"files": [
{
"id": "2000000028005",
"url": "https://www.apple.com/iphone-15/"
},
{
"id": "2000000028007",
"url": "https://www.apple.com/iphone-11/"
},
]
}
}
Obtener materiales de entrenamiento
Esta API te permite obtener los detalles y los metadatos de los materiales de entrenamiento asociados con un bot de ConvoKraft particular.
Puedes integrar esta funcionalidad en tu aplicación de Catalyst usando la API proporcionada a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
Nota:
-
El parámetro de consulta type=DEVELOPED se usa para indicar que el bot está en estado de desarrollo dentro del servicio ConvoKraft.
-
Puedes obtener el botid directamente desde la URL en el servicio ConvoKraft cuando el entorno está configurado en Development en la consola.
Por ejemplo : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
Aquí, 3828281991118 es el botid.
Scope
ZIAPlatform.Convokraft.RAG.READ
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
Detalles de la respuesta
Esta API proporciona los detalles y los metadatos de todos los materiales de entrenamiento asociados con el bot, incluyendo el ID único generado por ConvoKraft, el título, la URL y el estado de cada material de entrenamiento. También incluye información sobre la creación y modificación de los materiales, como la dirección de correo electrónico del usuario, zona horaria, ZUID, rol y otros detalles relevantes, junto con las marcas de tiempo de creación y modificación.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’ \
{
“rag_training_data”: [
{
“id”: “67799000000085007”,
“title”: “Iphone 15 Specifications”,
“url”: “https://www.apple.com/iphone-15/”,
“source”: “URL”,
“created_by”: {
“id”: “76859507”,
“email”: “amelia.burrows@zylker.com”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “amelia”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“created_time”: “1732880033148”,
“modified_by”: {
“id”: “76859507”,
“email”: “amelia.burrows@zylker.com”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “nivetha.raja”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“modified_time”: “1732880389581”,
“status”: “TRAINED”
},
{
“id”: “67799000000085009”,
“title”: “Iphone 11 Specifications”,
“url”: “https://www.apple.com/iphone-11/”,
“source”: “URL”,
“created_by”: {
“id”: “76859507”,
“email”: “amelia.burrows”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “amelia”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“created_time”: “1732880131250”,
“modified_by”: {
“id”: “76859507”,
“email”: “amelia.burrows@zylker.com”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “amelia”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“modified_time”: “1732880131250”,
“status”: “TRAINED”
}
]
}
Eliminar material de entrenamiento
Esta API te permite eliminar los materiales de entrenamiento personalizados cargados a la función SmartTrain en el bot de ConvoKraft proporcionando el ID único asignado a cada material en la solicitud. También puedes eliminar múltiples materiales a la vez pasando los IDs separados por comas. Ten en cuenta que eliminar el material de entrenamiento eliminará automáticamente el conocimiento entrenado en el bot, y no podrá responder consultas basadas en el material de entrenamiento eliminado.
Puedes integrar esta funcionalidad en tu aplicación de Catalyst usando la API proporcionada a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
Nota:
-
El parámetro de consulta type=DEVELOPED se usa para indicar que el bot está en estado de desarrollo dentro del servicio ConvoKraft.
-
Puedes obtener el botid directamente desde la URL en el servicio ConvoKraft cuando el entorno está configurado en Development en la consola.
Por ejemplo : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
Aquí, 3828281991118 es el botid.
Scope
ZIAPlatform.Convokraft.RAG.DELETE
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
Propiedades JSON de la solicitud
Detalles de la respuesta
Esta API devuelve el estado de la operación de eliminación junto con su código de estado y mensaje.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’
--data ‘{
“rag_training_data”: [
{
“id”: “67799000000084013”
}
]
}’
{
“status”: “SUCCESS”,
“code”: “SUCCESS”,
“message”: “Updated Successfully.”
}
Obtener respuesta del bot
Esta API te permite recuperar una respuesta del bot de ConvoKraft enviando una consulta de transcripción. El bot entenderá la pregunta y responderá con una respuesta basada en su entrenamiento.
Puedes integrar esta funcionalidad en tu aplicación de Catalyst usando la API proporcionada a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/convokraft/api/v1/bots/{production_botid}/answer
Nota: Puedes obtener el production_botid directamente desde la URL en el servicio ConvoKraft cuando el entorno está configurado en Production en la consola.
Por ejemplo : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Production#/convokraft/bots/3828281991118
Aquí, 3828281991118 es el production_botid.
Scope
ZIAPlatform.Convokraft.RAG.CREATE
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
Detalles de la respuesta
La API devuelve la respuesta proporcionada por ConvoKraft basándose en el material de entrenamiento, junto con el estado del proceso de recuperación de la respuesta.
curl -X POST
https://api.catalyst.zoho.com/convokraft/api/v1/bots/92738220219110/answer
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Production”’
--data ‘{
“transcript”: {
“message”: “Explain Iphone 11 Specifications”
}
}’
{
“transcript”: {
“message”: “The iPhone 11 is a sleek and powerful smartphone from Apple, featuring a 6.1-inch Liquid Retina HD display that offers vibrant colors and sharp detail. It’s powered by the A13 Bionic chip, which ensures fast performance and smooth multitasking. Whether you’re gaming, editing photos, or using apps, the iPhone 11 can handle it with ease.
One of the standout features of the iPhone 11 is its camera system. It has a dual-camera setup, with a 12MP wide and ultra-wide lens, making it great for capturing detailed photos and videos. The Night Mode feature helps take clearer pictures in low-light environments, and it also supports 4K video recording at 60fps, allowing you to shoot high-quality videos.”,
“status”: “action_completion”
}
}
API de Job Scheduling
Job Scheduling es un servicio de Catalyst que te permite programar envíos de jobs y ejecutarlos en un Job Pool para activar Circuits, Webhooks (cualquier URL de terceros), Job Functions y endpoints de servicios AppSail.
Obtener Todos los Job Pools
Descripción
Esta API te permite obtener los detalles de todos los Job Pools presentes en el proyecto.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/jobpool
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.jobpool.READ
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos de todos los Job Pools presentes en el proyecto. La respuesta también contendrá los detalles del usuario que lo creó y lo modificó por última vez.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/jobpool
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": [
{
"type": "AppSail",
"name": "TriggerMicroservice",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:51 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:51 PM",
"capacity": {
"number": "1"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823795"
},
{
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
{
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
{
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
}
]
}
Obtener Job Pool por Identificador
Descripción
Esta API te permite obtener los detalles de un job pool específico. El Job Pool se referencia por su ID único de Job Pool o por su nombre.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/jobpool/{jobpool_identifier}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.jobpool.READ
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos de un cron específico presente en el proyecto. La respuesta también contendrá los detalles del usuario que lo creó y lo modificó por última vez.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004154323
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"cron_name": "pcMonthlyDay",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004154323",
"url": "",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004154321",
"source_name": "pcMonthlyDay",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"capacity": {
"number": "5"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"request_method": "get"
},
"cron_status": true,
"created_time": "Jun 04, 2024 04:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 04:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"end_time": "1718303399",
"cron_detail": {
"hour": 4,
"minute": 4,
"second": 4,
"repetition_type": "monthly",
"days": [
1,
3,
4
],
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004154321"
}
}
Enviar Webhook Job por ID
Descripción
Esta API te permite enviar un job a un Job Pool que activa un endpoint de Webhook.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.job.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"request_method": "post",
"source_type": "API",
"job_config": {
"number_of_retries": "2",
"retry_interval": 1800
},
"job_name": "webhookPost",
"jobpool_id": "10108000003823632",
"target_type": "Webhook",
"url": "https://www.zoho.com",
"headers": {
"h1": "v1"
},
"request_body": "{'key1':'val1'}"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del job enviado. La respuesta también contendrá los detalles del usuario que envió el job.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw $’{“request_method”:“post”,“source_type”:“API”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:1800},“job_name”:“webhookPost”,“jobpool_id”:“10108000003823632”,“target_type”:“Webhook”,“url”:“https://www.zoho.com”,“headers”:{“h1”:“v1”},“request_body”:"{'key1':'val1'}"}'
{
"status": "success",
"data": {
"job_id": "10108000004194125",
"created_time": "Jun 05, 2024 04:37 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:32",
"timeWithGivenTimezone": "Jun 05, 2024 04:37 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 04:37 PM IST"
},
"job_status": "PENDING",
"capacity": {
"number": "1"
},
"job_meta_details": {
"id": "10108000004194126",
"url": "https://www.zoho.com",
"job_name": "webhookPost",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1800
},
"target_type": "Webhook",
"target_details": {
"target_name": "https://www.zoho.com"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823632",
"jobpool_details": {
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
"headers": {
"h1": "v1"
},
"params": {},
"request_method": "post",
"request_body": "{'key1':'val1'}"
},
"retried_count": null,
"parent_job_id": "10108000004194125",
"execution_time": null
}
}
Enviar un Function Job por ID
Descripción
Esta API te permite enviar un job a un Job Pool que activa un endpoint de Job Function.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.job.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"source_type": "API",
"job_config": {
"number_of_retries": "2",
"retry_interval": 10800
},
"job_name": "functionJob",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del job enviado. La respuesta también contendrá los detalles del usuario que envió el job.
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“source_type”:“API”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:10800},“job_name”:“functionJob”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}}’
{
"status": "success",
"data": {
"job_id": "10108000004194195",
"created_time": "Jun 05, 2024 04:51 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:46",
"timeWithGivenTimezone": "Jun 05, 2024 04:51 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 04:51 PM IST"
},
"job_status": "PENDING",
"capacity": {
"memory": "512"
},
"job_meta_details": {
"id": "10108000004194196",
"url": "",
"job_name": "functionJob",
"job_config": {
"number_of_retries": 2,
"retry_interval": 10800
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"retried_count": null,
"parent_job_id": "10108000004194195",
"execution_time": null
}
}
Enviar un Circuit Job por ID
Descripción
Esta API te permite enviar un job a un Job Pool que activa un endpoint de Circuit.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.job.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"source_type": "API",
"job_config": {
"number_of_retries": "4",
"retry_interval": 300
},
"job_name": "circuitJob",
"jobpool_id": "10108000003823699",
"target_type": "Circuit",
"target_id": "10108000004194246",
"test_cases": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del job enviado. La respuesta también contendrá los detalles del usuario que envió el job.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“source_type”:“API”,“job_config”:{“number_of_retries”:“4”,“retry_interval”:300},“job_name”:“circuitJob”,“jobpool_id”:“10108000003823699”,“target_type”:“Circuit”,“target_id”:“10108000004194246”,“test_cases”:{“key1”:“value1”,“key2”:“value2”,“key3”:“value3”}}’
{
"status": "success",
"data": {
"job_id": "10108000004194251",
"created_time": "Jun 05, 2024 04:56 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:51",
"timeWithGivenTimezone": "Jun 05, 2024 04:56 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 04:56 PM IST"
},
"job_status": "PENDING",
"capacity": {
"number": "1"
},
"job_meta_details": {
"id": "10108000004194252",
"job_name": "circuitJob",
"job_config": {
"number_of_retries": 4,
"retry_interval": 300
},
"target_type": "Circuit",
"target_details": {
"id": "10108000004194246",
"target_name": "abc"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823699",
"jobpool_details": {
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
"headers": {},
"params": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"retried_count": null,
"parent_job_id": "10108000004194251",
"execution_time": null
}
}
Enviar un Job de AppSail por ID
Descripción
Esta API te permite enviar un job a un Job Pool que activa el endpoint de un servicio AppSail.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.job.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"request_method": "get",
"source_type": "API",
"job_config": {
"number_of_retries": "3",
"retry_interval": 300
},
"job_name": "appsailJob",
"jobpool_id": "10108000002976201",
"target_type": "AppSail",
"target_id": "10108000002976191",
"url": "",
"headers": {
"h1": "k1"
},
"params": {
"p1": "v1"
}
}
Alimentarás este JSON de solicitud en tu cuerpo de solicitud, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del job enviado. La respuesta también contendrá los detalles del usuario que envió el job.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“request_method”:“get”,“source_type”:“API”,“job_config”:{“number_of_retries”:“3”,“retry_interval”:300},“job_name”:“appsailJob”,“jobpool_id”:“10108000002976201”,“target_type”:“AppSail”,“target_id”:“10108000002976191”,“url”:"",“headers”:{“h1”:“k1”},“params”:{“p1”:“v1”}}’
{
"status": "success",
"data": {
"job_id": "10108000004194320",
"created_time": "Jun 05, 2024 05:02 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:57",
"timeWithGivenTimezone": "Jun 05, 2024 05:02 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 05:02 PM IST"
},
"job_status": "PENDING",
"capacity": {
"number": "1"
},
"job_meta_details": {
"id": "10108000004194321",
"url": "",
"job_name": "appsailJob",
"job_config": {
"number_of_retries": 3,
"retry_interval": 300
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"headers": {
"h1": "k1"
},
"params": {
"p1": "v1"
},
"request_method": "get"
},
"retried_count": null,
"parent_job_id": "10108000004194320",
"execution_time": null
}
}
Get Job By ID
Descripción
Esta API te permite recuperar los detalles de un Job específico. El Job se referencia por su Job ID único.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job/{job_id}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.job.READ
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos de un job específico presente en el proyecto. La respuesta también contendrá los detalles del usuario que lo creó y lo modificó por última vez.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/job/10278000000027019
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"job_id": "10108000003880208",
"created_time": "May 29, 2024 02:29 PM",
"response_code": "Success",
"start_time": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"end_time": {
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST",
"endTimeToRedirectLogsPage": "29/05/2024 14:34"
},
"submitted_on": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"job_status": "SUCCESS",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10108000003880209",
"url": "",
"job_name": "abc",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {}
},
"retried_count": 0,
"parent_job_id": "10108000003880208",
"execution_time": "633",
"status": false,
"dispatch_delay": "103"
}
}
Crear un Cron usando expresiones Cron
Descripción
Esta API te permite crear un cron de tipo recurrente definido usando expresiones Cron que en el momento programado enviará un job al job pool y activará un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API sigue siendo la misma para webhook, Circuits y jobs de AppSail.
-
Esta API es aplicable para Crons predefinidos y Crons dinámicos.
Detalles de la solicitud
URL de solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "CronExpression",
"cron_status": true,
"cron_expression": "* * * * *",
"job_detail": {
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "500"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "cronExp",
"description": "cronexpression",
"end_time": 1717916399,
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu cuerpo de solicitud, y necesitas proporcionar el valor de:
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“CronExpression”,“cron_status”:true,“cron_expression”:"* * * * *",“job_detail”:{“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“500”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“cronExp”,“description”:“cronexpression”,“end_time”:1717916399,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "cronExp",
"description": "cronexpression",
"cron_type": "CronExpression",
"cron_execution_type": "pre-defined",
"cron_expression": "* * * * *",
"job_meta": {
"id": "10108000004280709",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280707",
"source_name": "cronExp",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:51 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:51 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717916399",
"cron_detail": {
"jobId": "10108000004280707",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280707"
}
}
Eliminar Job por ID
Descripción
Esta API te permite eliminar un job presente en un Job Pool. El Job se referencia por su job_id.
Detalles de la Solicitud
URL de Solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job/{job_id}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.job.DELETE
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del job eliminado. La respuesta también contendrá los detalles del usuario que eliminó el job.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/job/10278000000027019
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"job_id": "10278000000027019",
"created_time": "May 29, 2024 02:29 PM",
"response_code": "Success",
"start_time": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"end_time": {
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST",
"endTimeToRedirectLogsPage": "29/05/2024 14:34"
},
"submitted_on": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"job_status": "SUCCESS",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10278000000027019",
"url": "",
"job_name": "abc",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {}
},
"retried_count": 0,
"parent_job_id": "10108000003880208",
"execution_time": "633",
"status": false,
"dispatch_delay": "103"
}
}
Obtener Cron por identificador
Descripción
Esta API te permite obtener todos los detalles disponibles de un cron presente en el proyecto. El cron se referencia por su identificador único como ID o nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id/cron_name}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.READ
Detalles de la respuesta
La respuesta JSON devuelve los metadatos de un cron específico presente en el proyecto. La respuesta también contendrá los detalles del usuario que lo creó y lo modificó por última vez.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004154323
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"cron_name": "pcMonthlyDay",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004154323",
"url": "",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004154321",
"source_name": "pcMonthlyDay",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"capacity": {
"number": "5"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"request_method": "get"
},
"cron_status": true,
"created_time": "Jun 04, 2024 04:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 04:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"end_time": "1718303399",
"cron_detail": {
"hour": 4,
"minute": 4,
"second": 4,
"repetition_type": "monthly",
"days": [
1,
3,
4
],
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004154321"
}
}
Obtener todos los Crons
Descripción
Esta API te permite recuperar los detalles de todos los Crons predefinidos presentes en el proyecto.
Detalles de la solicitud
URL de solicitud
{app_domain}/baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.READ
Detalles de la respuesta
La respuesta JSON devuelve los metadatos de todos los crons presentes en el proyecto. La respuesta también contendrá los detalles del usuario que creó y modificó por última vez el cron.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": [
{
"cron_name": "circuitCron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280089",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Circuit",
"target_details": {
"id": "10108000004194246",
"target_name": "abc"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280087",
"source_name": "circuitCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823699",
"jobpool_details": {
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
"headers": {},
"params": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 11:09 AM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 11:09 AM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717871399",
"cron_detail": {
"hour": 4,
"minute": 3,
"second": 0,
"repetition_type": "daily",
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004280087"
},
{
"cron_name": "functionCron",
"description": "functionCron",
"cron_type": "CronExpression",
"cron_execution_type": "pre-defined",
"cron_expression": "* * * * *",
"job_meta": {
"id": "10108000004280074",
"url": "",
"job_name": "functionJob",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280072",
"source_name": "functionCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"p1": "v1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 11:08 AM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 11:08 AM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718908199",
"cron_detail": {
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004280072"
},
{
"cron_name": "abcUpdated",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004153012",
"url": "https://www.google.com",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Webhook",
"target_details": {
"target_name": "https://www.google.com"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004152971",
"source_name": "abcUpdated",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823632",
"jobpool_details": {
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
"request_method": "get"
},
"cron_status": false,
"created_time": "Jun 04, 2024 03:56 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 03:57 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"time_of_execution": 1717612200,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004152971"
},
{
"cron_name": "abcupdate",
"description": "abc",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004108000",
"url": "https://www.google.com",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Webhook",
"target_details": {
"target_name": "https://www.google.com"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004107959",
"source_name": "abcupdate",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823632",
"jobpool_details": {
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
"headers": {},
"params": {},
"request_method": "get"
},
"cron_status": false,
"created_time": "Jun 03, 2024 05:19 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 03, 2024 05:20 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"time_of_execution": 1717623183,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004107959"
}
]
}
Crear un Cron de Una Sola Vez
Descripción
Esta API te permite crear un cron de una sola vez que envía un Job al Job Pool para activar un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "OneTime",
"cron_status": true,
"job_detail": {
"time_of_execution": 1717916399,
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "60"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "oneTimeCronFn",
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“OneTime”,“cron_status”:true,“job_detail”:{“time_of_execution”:1717916399,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“60”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893” ,“params”:{“param1”:“value1”}},“cron_name”:“oneTimeCronFn”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "oneTimeCronFn",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280446",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280444",
"source_name": "oneTimeCronFn",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:26 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:26 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"jobId": "10108000004280444",
"transactionTimeout": -1,
"time_of_execution": 1717916399,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280444"
}
}
Crear un Cron periódico
Descripción
Esta API te permite crear un cron de tipo recurrente periódico que en el momento programado envía un Job al Job Pool y activa un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API sigue siendo la misma para webhook, Circuits y jobs de AppSail.
-
Esta API es aplicable para Crons predefinidos y Crons dinámicos.
Detalles de la solicitud
URL de solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "Periodic",
"cron_status": true,
"job_detail": {
"repetition_type": "every",
"hour": "6",
"minute": "0",
"second": "0"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "3",
"retry_interval": "60"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"end_time": 1717957799,
"cron_name": "RecursiveCron",
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu cuerpo de solicitud, y necesitas proporcionar el valor de:
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Periodic”,“cron_status”:true,“job_detail”:{“repetition_type”:“every”,“hour”:“6”,“minute”:“0”,“second”:“0”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“3”,“retry_interval”:“60”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“end_time”:1717957799,“cron_name”:“RecursiveCron”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCron",
"cron_type": "Periodic",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280482",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 3,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280480",
"source_name": "RecursiveCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717957799",
"cron_detail": {
"jobId": "10108000004280480",
"transactionTimeout": -1,
"hour": 6,
"minute": 0,
"second": 0,
"repetition_type": "every",
"timezone": "Asia/Kolkata"
},
"id": "10108000004280480"
}
}
Crear un Cron diario
Descripción
Esta API te permite crear un cron de tipo recurrente diario que en el momento programado envía un Job al Job Pool y activa un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API sigue siendo la misma para webhook, Circuits y jobs de AppSail.
-
Esta API es aplicable para Crons predefinidos y Crons dinámicos.
Detalles de la solicitud
URL de solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "daily",
"hour": "1",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "300"
},
"job_name": "job",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "RecursiveCronDaily",
"end_time": 1718002799,
"description": "dailycron",
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu cuerpo de solicitud, y necesitas proporcionar el valor de:
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“daily”,“hour”:“1”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“300”},“job_name”:“job”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“RecursiveCronDaily”,“end_time”:1718002799,“description”:“dailycron”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCronDaily",
"description": "dailycron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280518",
"url": "",
"job_name": "job",
"job_config": {
"number_of_retries": 1,
"retry_interval": 300
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280516",
"source_name": "RecursiveCronDaily",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:33 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:33 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280516",
"transactionTimeout": -1,
"hour": 1,
"minute": 0,
"second": 0,
"repetition_type": "daily",
"timezone": "PST"
},
"id": "10108000004280516"
}
}
Crear un Cron mensual (tipo fecha)
Descripción
Esta API te permite crear un cron de tipo recurrente mensual (definido usando la fecha del calendario) que en el momento programado envía un job al job pool y activa un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API sigue siendo la misma para webhook, Circuits y jobs de AppSail.
-
Esta API es aplicable para Crons predefinidos y Crons dinámicos.
Detalles de la solicitud
URL de solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "monthly",
"days": [
"1",
"3",
"8"
],
"hour": "3",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "2",
"retry_interval": "500"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronMonthly",
"end_time": 1718002799,
"description": "monthly",
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu cuerpo de solicitud, y necesitas proporcionar el valor de:
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“monthly”,“days”:[“1”,“3”,“8”],“hour”:“3”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:“500”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronMonthly”,“end_time”:1718002799,“description”:“monthly”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronMonthly",
"description": "monthly",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280537",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280535",
"source_name": "recurCronMonthly",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:35 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:35 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280535",
"transactionTimeout": -1,
"hour": 3,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"days": [
1,
3,
8
],
"timezone": "PST"
},
"id": "10108000004280535"
}
}
Crear un Cron Mensual (Tipo Semana)
Descripción
Esta API te permite crear un cron de tipo recurrente Monthly (definido usando las semanas de un mes) que en el momento programado envía un job al job pool y activa un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "monthly",
"weeks_of_month": [
"1",
"2",
"3"
],
"week_day": [
"1"
],
"hour": "0",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "2",
"retry_interval": "600"
},
"job_name": "job",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronMonthlyWeek",
"description": "week",
"end_time": 1718607599,
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“monthly”,“weeks_of_month”:[“1”,“2”,“3”],“week_day”:[“1”],“hour”:“0”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:“600”},“job_name”:“job”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronMonthlyWeek”,“description”:“week”,“end_time”:1718607599,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronMonthlyWeek",
"description": "week",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280565",
"url": "",
"job_name": "job",
"job_config": {
"number_of_retries": 2,
"retry_interval": 600
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280563",
"source_name": "recurCronMonthlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:37 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:37 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718607599",
"cron_detail": {
"jobId": "10108000004280563",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"weeks_of_month": [
1,
2,
3
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280563"
}
}
Crear un Cron Anual (Tipo Día)
Descripción
Esta API te permite crear un cron de tipo recurrente Yearly (definido usando la fecha del calendario), que en el momento programado enviará un job al job pool y activará un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "yearly",
"months": [
"0",
"1"
],
"days": [
"1",
"2",
"3",
"6",
"8"
],
"hour": "0",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "500"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronYearlyday",
"description": "yearlyday",
"end_time": 1719125999,
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“yearly”,“months”:[“0”,“1”],“days”:[“1”,“2”,“3”,“6”,“8”],“hour”:“0”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“500”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronYearlyday”,“description”:“yearlyday”,“end_time”:1719125999,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronYearlyday",
"description": "yearlyday",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280594",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280592",
"source_name": "recurCronYearlyday",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:39 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:39 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1719125999",
"cron_detail": {
"jobId": "10108000004280592",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"days": [
1,
2,
3,
6,
8
],
"months": [
0,
1
],
"timezone": "PST"
},
"id": "10108000004280592"
}
}
Crear un Cron Anual (Tipo Semana)
Descripción
Esta API te permite crear un cron de tipo recurrente Yearly (definido usando las semanas del calendario) que en el momento programado enviará un job al job pool y activará un endpoint de Job Function.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "yearly",
"months": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11"
],
"weeks_of_month": [
"1",
"3",
"5"
],
"week_day": [
"1"
],
"hour": "0",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "2",
"retry_interval": "1000"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"end_time": 1719212399,
"cron_execution_type": "pre-defined"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“yearly”,“months”:[“0”,“1”,“2”,“3”,“4”,“5”,“6”,“7”,“8”,“9”,“10”,“11”],“weeks_of_month”:[“1”,“3”,“5”],“week_day”:[“1”],“hour”:“0”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:“1000”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronYearlyWeek”,“description”:“abc”,“end_time”:1719212399,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280663",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1000
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280661",
"source_name": "recurCronYearlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:45 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:45 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1719212399",
"cron_detail": {
"jobId": "10108000004280661",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"months": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"weeks_of_month": [
1,
3,
5
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280661"
}
}
Actualizar un Cron de Una Sola Vez
Descripción
Esta API te permite actualizar un cron one-time presente en el proyecto. El cron que necesita ser actualizado será referenciado usando su identificador único, como nombre o ID.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_name": "oneTimeCronFn",
"cron_type": "OneTime",
"cron_status": true,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280446",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280444",
"source_name": "oneTimeCronFn",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"time_of_execution": 1718002799,
"timezone": "PST"
},
"id": "10108000004280444"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron actualizado. La respuesta también contendrá los detalles del usuario que actualizó el cron.
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280444
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“oneTimeCronFn”,“cron_type”:“OneTime”,“cron_status”:true,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280446”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:1,“retry_interval”:60},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280444”,“source_name”:“oneTimeCronFn”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“time_of_execution”:1718002799,“timezone”:“PST”},“id”:“10108000004280444”}’
{
"status": "success",
"data": {
"cron_name": "oneTimeCronFn",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280726",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280444",
"source_name": "oneTimeCronFn",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 12:53 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"jobId": "10108000004280444",
"transactionTimeout": -1,
"time_of_execution": 1718002799,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280444"
}
}
Actualizar un Cron Every
Descripción
Esta API te permite actualizar un cron de tipo recurrente Every presente en el proyecto. El cron que necesita ser actualizado será referenciado usando su identificador único, como nombre o ID.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_name": "RecursiveCronEvery",
"cron_type": "Periodic",
"cron_status": true,
"end_time": 1717957799,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280482",
"job_name": "jobName",
"job_config": {
"number_of_retries": 3,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280480",
"source_name": "RecursiveCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": 6,
"minute": 0,
"second": 0,
"repetition_type": "every"
},
"id": "10108000004280480"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron actualizado. La respuesta también contendrá los detalles del usuario que actualizó el cron.
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280480
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“RecursiveCronEvery”,“cron_type”:“Periodic”,“cron_status”:true,“end_time”:1717957799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280482”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:3,“retry_interval”:60},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280480”,“source_name”:“RecursiveCron”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:6,“minute”:0,“second”:0,“repetition_type”:“every”},“id”:“10108000004280480”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCronEvery",
"cron_type": "Periodic",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280762",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 3,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280480",
"source_name": "RecursiveCronEvery",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 12:56 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717957799",
"cron_detail": {
"hour": 6,
"minute": 0,
"second": 0,
"repetition_type": "every",
"timezone": "Asia/Kolkata"
},
"id": "10108000004280480"
}
}
Actualizar un Cron Diario
Descripción
Esta API te permite actualizar un cron Daily presente en el proyecto. El cron que necesita ser actualizado será referenciado usando su identificador único, como nombre o ID.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_name": "RecursiveCronDaily",
"description": "dailycron",
"cron_type": "Calendar",
"cron_status": true,
"end_time": 1718002799,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280518",
"job_name": "job",
"job_config": {
"number_of_retries": 1,
"retry_interval": 300
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280516",
"source_name": "RecursiveCronDaily",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": "2",
"minute": 0,
"second": 0,
"repetition_type": "daily",
"timezone": "PST"
},
"id": "10108000004280516"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron actualizado. La respuesta también contendrá los detalles del usuario que actualizó el cron.
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280516
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“RecursiveCronDaily”,“description”:“dailycron”,“cron_type”:“Calendar”,“cron_status”:true,“end_time”:1718002799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280518”,“job_name”:“job”,“job_config”:{“number_of_retries”:1,“retry_interval”:300},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280516”,“source_name”:“RecursiveCronDaily”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:“2”,“minute”:0,“second”:0,“repetition_type”:“daily”,“timezone”:“PST”},“id”:“10108000004280516”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCronDaily",
"description": "dailycron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280784",
"url": "",
"job_name": "job",
"job_config": {
"number_of_retries": 1,
"retry_interval": 300
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280516",
"source_name": "RecursiveCronDaily",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 12:59 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280516",
"transactionTimeout": -1,
"hour": 2,
"minute": 0,
"second": 0,
"repetition_type": "daily",
"timezone": "PST"
},
"id": "10108000004280516"
}
}
Actualizar un Cron Mensual (Tipo Fecha)
Descripción
Esta API te permite actualizar un cron Monthly (configurado usando las fechas del calendario) presente en el proyecto. El cron que necesita ser actualizado será referenciado usando su identificador único, como nombre o ID.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
La funcionalidad de la API es la misma cuando intentas actualizar un cron Monthly definido usando las semanas de un mes. Consulta Create a Monthly Cron (Week Type) API.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_name": "recurCronMonthly",
"description": "monthly",
"cron_type": "Calendar",
"cron_status": true,
"end_time": 1718002799,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280537",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280535",
"source_name": "recurCronMonthly",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": 3,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"days": [
1,
3,
8,
"9"
],
"timezone": "PST"
},
"id": "10108000004280535"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron actualizado. La respuesta también contendrá los detalles del usuario que actualizó el cron.
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280535
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“recurCronMonthly”,“description”:“monthly”,“cron_type”:“Calendar”,“cron_status”:true,“end_time”:1718002799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280537”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:2,“retry_interval”:500},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280535”,“source_name”:“recurCronMonthly”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:3,“minute”:0,“second”:0,“repetition_type”:“monthly”,“days”:[1,3,8,“9”],“timezone”:“PST”},“id”:“10108000004280535”}’
{
"status": "success",
"data": {
"cron_name": "recurCronMonthly",
"description": "monthly",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280805",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280535",
"source_name": "recurCronMonthly",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 01:00 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280535",
"transactionTimeout": -1,
"hour": 3,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"days": [
1,
3,
8,
9
],
"timezone": "PST"
},
"id": "10108000004280535"
}
}
Actualizar un Cron Anual (Tipo Semana)
Descripción
Esta API te permite actualizar un cron Yearly (definido usando las semanas de un mes) presente en el proyecto. El cron que necesita ser actualizado será referenciado usando su identificador único, como nombre o ID.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
La funcionalidad de la API es la misma cuando intentas actualizar un cron Yearly definido usando las fechas de un mes. Consulta Create a Yearly Cron (Date Type) API.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier(name/ID)}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"cron_type": "Calendar",
"cron_status": true,
"end_time": 1719212399,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280663",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1000
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280661",
"source_name": "recurCronYearlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"months": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"weeks_of_month": [
1,
3,
5,
"4"
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280661"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron actualizado. La respuesta también contendrá los detalles del usuario que actualizó el cron.
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280535
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“recurCronYearlyWeek”,“description”:“abc”,“cron_type”:“Calendar”,“cron_status”:true,“end_time”:1719212399,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280663”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:2,“retry_interval”:1000},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280661”,“source_name”:“recurCronYearlyWeek”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:0,“minute”:0,“second”:0,“repetition_type”:“yearly”,“months”:[0,1,2,3,4,5,6,7,8,9,10,11],“weeks_of_month”:[1,3,5,“4”],“week_day”:[1],“timezone”:“PST”},“id”:“10108000004280661”}’
{
"status": "success",
"data": {
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280844",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1000
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280661",
"source_name": "recurCronYearlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 01:03 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1719212399",
"cron_detail": {
"jobId": "10108000004280661",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"months": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"weeks_of_month": [
1,
3,
4,
5
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280661"
}
}
Actualizar un Cron Definido Usando Expresiones Cron
Descripción
Esta API te permite actualizar un cron definido usando Cron Expressions. El cron que necesita ser actualizado será referenciado usando su identificador único, como nombre o ID.
Nota:
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API es la misma para webhook, Circuits y AppSail jobs.
-
Esta API es aplicable para Pre-Defined Crons y Dynamic Crons.
Detalles de la Solicitud
URL de Solicitud
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier(name/ID)}
Encabezados de Solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Encabezados Opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
JSON de Solicitud
Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.
{
"cron_name": "cronExp",
"description": "cronexpression",
"cron_type": "CronExpression",
"cron_status": true,
"end_time": 1717916399,
"cron_execution_type": "pre-defined",
"cron_expression": "/30 /6 * * *",
"job_meta": {
"id": "10108000004280709",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280707",
"source_name": "cronExp",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"timezone": "PST"
},
"id": "10108000004280707"
}
Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:
Detalles de la Respuesta
La respuesta JSON devuelve los metadatos del cron actualizado. La respuesta también contendrá los detalles del usuario que actualizó el cron.
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280535
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“cronExp”,“description”:“cronexpression”,“cron_type”:“CronExpression”,“cron_status”:true,“end_time”:1717916399,“cron_execution_type”:“pre-defined”,“cron_expression”:"/30 /6 * * *",“job_meta”:{“id”:“10108000004280709”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:1,“retry_interval”:500},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280707”,“source_name”:“cronExp”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“timezone”:“PST”},“id”:“10108000004280707”}’
{
"status": "success",
"data": {
"cron_name": "cronExp",
"description": "cronexpression",
"cron_type": "CronExpression",
"cron_execution_type": "pre-defined",
"cron_expression": "/30 /6 * * *",
"job_meta": {
"id": "10108000004280861",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280707",
"source_name": "cronExp",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 01:04 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717916399",
"cron_detail": {
"jobId": "10108000004280866",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280707"
}
}
Enviar Cron instantáneamente
Descripción
Esta API te permite enviar un cron que instantáneamente enviará un job al job pool para activar un endpoint de tipo destino.
Nota:
-
Esta API se utiliza idealmente para probar si el cron configurado está funcionando según lo configurado.
-
En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API sigue siendo la misma para webhook, Circuits y jobs de AppSail.
-
Esta API es aplicable para Crons predefinidos y Crons dinámicos.
Detalles de la solicitud
URL de solicitud
{app_domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id}/submit_job
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.CREATE
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron enviado. La respuesta también contendrá los detalles del usuario que envió el cron.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000003822189/submit_immediately
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"job_id": "10108000004251242",
"created_time": "Jun 07, 2024 10:32 AM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "07/06/2024 10:27",
"timeWithGivenTimezone": "Jun 07, 2024 10:32 AM IST",
"timeWithJobTimezone": "Jun 07, 2024 10:32 AM IST"
},
"job_status": "PENDING",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10108000003822191",
"url": "",
"job_name": "delayJob",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003822071",
"target_name": "fn"
},
"source_type": "Cron",
"source_details": {
"id": "10108000003822189",
"source_name": "check2",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003822066",
"headers": {},
"params": {}
},
"retried_count": null,
"parent_job_id": "10108000004251242",
"execution_time": null,
"cron_circuit_id": null,
"circuit_execution": null,
"status": false
}
}
Actualizar Cron parcialmente
Descripción
Esta API te permite habilitar o deshabilitar un cron presente en el proyecto. El cron se referencia por su identificador único como ID.
Detalles de la solicitud
URL de solicitud
{app_domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.UPDATE
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron que necesitas habilitar o deshabilitar. La respuesta también contendrá los detalles del usuario que cambió el estado del cron.
curl -X PATCH
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004280087
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“id”:“10108000004280087”,“cron_status”:false}’
{
"status": "success",
"data": {
"cron_name": "circuitCron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280089",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Circuit",
"target_details": {
"id": "10108000004194246",
"target_name": "abc"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280087",
"source_name": "circuitCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823699",
"jobpool_details": {
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
"headers": {},
"params": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"cron_status": false,
"created_time": "Jun 07, 2024 11:09 AM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 11:09 AM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717871399",
"cron_detail": {
"hour": 4,
"minute": 3,
"second": 0,
"repetition_type": "daily",
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004280087"
}
}
Eliminar Cron
Descripción
Esta API te permite eliminar un cron presente en el proyecto. El cron se referencia por su identificador único como ID o nombre.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id/cron_name}
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Encabezados opcionales
CATALYST-ORG: {org_id}
Environment: Development
Alcance
ZohoCatalyst.cron.DELETE
Detalles de la respuesta
La respuesta JSON devuelve los metadatos del cron eliminado. La respuesta también contendrá los detalles del usuario que eliminó el cron.
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004154323
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57
{
"status": "success",
"data": {
"cron_name": "pcMonthlyDay",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004154323",
"url": "",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004154321",
"source_name": "pcMonthlyDay",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"capacity": {
"number": "5"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"request_method": "get"
},
"cron_status": true,
"created_time": "Jun 04, 2024 04:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 04:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"end_time": "1718303399",
"cron_detail": {
"hour": 4,
"minute": 4,
"second": 4,
"repetition_type": "monthly",
"days": [
1,
3,
4
],
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004154321"
}
}
Catalyst Pipelines
Catalyst Pipelines es un servicio CI/CD de Catalyst que te permite automatizar los procesos de compilación, prueba y despliegue de tus aplicaciones. Puedes crear un pipeline desde la consola de Catalyst. Discutiremos las APIs que se pueden aprovechar para activar el pipeline y obtener los detalles de un pipeline existente en las siguientes secciones.
Obtener detalles del Pipeline
Esta API te permite obtener los detalles de un pipeline creado en la consola de Catalyst. Esto se puede hacer pasando el pipeline_id y el project_id en la URL de solicitud. La API obtiene los detalles del proyecto en el que se creó el pipeline y los detalles del pipeline.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}
El ID único del proyecto en el que se ha creado el pipeline
El ID único del pipeline para el que se deben obtener los detalles.
Alcance
pipeline.READ
Detalles de la respuesta
Se devolverá como respuesta el objeto de detalles del pipeline. Incluye detalles como el nombre del pipeline, detalles del proyecto incluyendo el project_name y project_type, los detalles del usuario que ha creado el pipeline incluyendo el user_id, email_id, first_name, last_name y user_type, el estado del pipeline, los detalles de los usuarios que modificaron el pipeline junto con los detalles del tiempo de modificación y también la configuración predeterminada del runner del pipeline.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57” \
{
“status”: “success”,
“data”: {
“pipeline_id”: “29810101101”,
“name”: “test1”,
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “4000000006007”,
“project_type”: “Live”
},
“created_by”: {
“zuid”: “20257791”,
“is_confirmed”: false,
“email_id”: “amelia.burrows@zylker.com”,
“first_name”: “Amelia”,
“last_name”: “Burrows”,
“user_type”: “Admin”,
“user_id”: “5000000000056”
},
“created_time”: “Mar 19, 2024 11:28 AM”,
“modified_by”: {
“zuid”: “20257791”,
“is_confirmed”: false,
“email_id”: “amelia.burrows@zylker.com”,
“first_name”: “Amelia”,
“last_name”: “Burrows”,
“user_type”: “Admin”,
“user_id”: “5000000000056”
},
“modified_time”: “Mar 19, 2024 11:28 AM”,
“git_account_id”: “”,
“mask_regex”: [
null
],
“pipeline_status”: “Active”,
“config_id”: 2,
“integ_id”: 1
}
}
Ejecutar Pipelines
Esta API te permite activar el pipeline en una rama particular del repositorio Git. Esto se puede hacer pasando el nombre de la rama como parámetro en el cuerpo de la solicitud. Al activar pipelines manuales, simplemente puedes ignorar el parámetro del nombre de la rama en el JSON de la solicitud.
Al activar esta API, el pipeline se ejecutará y el estado de la ejecución se devolverá como respuesta.
Obtener detalles del Pipeline
Esta API te permite obtener los detalles de un pipeline creado en la consola de Catalyst. Esto se puede hacer pasando el pipeline_id y el project_id en la URL de solicitud. La API obtiene los detalles del proyecto en el que se creó el pipeline y los detalles del pipeline.
Detalles de la solicitud
URL de solicitud
{api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}/run
El ID único del proyecto en el que se ha creado el pipeline
El ID único del pipeline para el que se deben obtener los detalles.
Propiedades JSON de la solicitud
Nota:
- BRANCH_NAME es opcional cuando necesitas activar un pipeline manual de Catalyst.
- Hemos agregado las claves EVENT y URL como variables de entorno. Puedes pasar cualquier clave requerida para la ejecución del pipeline en el JSON del evento.
Alcance
pipeline.execution.CREATE
Detalles de la respuesta
Se devolverá como respuesta un objeto que contiene los detalles del historial de creación del pipeline. El objeto incluye detalles como el history_id, event_time, history_status.
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101/run
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-d ‘{
“BRANCH_NAME” : “main”,
“EVENT”: “push”, \
“URL”: “https://www.google.com”
}
{
“status”: “success”,
“data”: {
“history_id”: “5000000021007”,
“pipeline_id”: “29810101101”,
“event_time”: “Mar 20, 2024 02:02 PM”,
“event_details”: {
“BRANCH_NAME”: “main”,
“EVENT”: “push”,
“URL”: “https://www.google.com”
},
“history_status”: “Queued”
}
}
Catalyst Slate
Slate es un robusto servicio de desarrollo front-end ofrecido por Catalyst que te permite desplegar, previsualizar y lanzar tus aplicaciones web sin problemas. Ofrece soporte nativo para los frameworks populares de JavaScript, como Next.js, Angular y React, mientras acomoda sin problemas otros frameworks de frontend para un despliegue sin complicaciones.
Redesplegar aplicación
Puedes activar una nueva compilación para un despliegue existente en Slate pasando el ID único del proyecto de Catalyst, el nombre específico de la aplicación Slate dentro del proyecto y el ID de despliegue a la API a continuación.
Detalles de la solicitud
URL de solicitud
{api-domain}/slate/v1/project/{project_id}/app/{app_id}/deployment/{deployment_id}/redeploy
Nota:
Abre el despliegue de Slate en la consola, y puedes obtener los siguientes valores de la URL.
Aquí, 26879000000021001 es el project_id. 1860000000007114 es el app_id y 1860000000007119 es el deployment_id.
Encabezados de solicitud
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
Propiedades JSON de la solicitud
Pasa variables de entorno como pares clave-valor a través del cuerpo de la solicitud.
Por ejemplo:
{“API_KEY”: “xxxxxxxx2433”}
Alcance
ZohoCatalyst.Slate.app.CREATE
Detalles de la respuesta
La respuesta incluirá el estado del nuevo despliegue de compilación, información detallada del despliegue, el mensaje de commit y la URL del commit obtenidos directamente del repositorio Git conectado, junto con metadatos adicionales.
curl -X POST
‘https://api.catalyst.zoho.com/slate/v1/project/4000000006007/app/29810101101/deployment/1860000000007119/redeploy'
-H ‘Authorization: Zoho-oauthtoken 1000.91016.2f57’
-H ‘Content-Type: application/json’
-d ‘{
{“API_KEY”: “xxxxxxx2433”}
}
{
“status”: “success”,
“data”: {
“id”: “2289000000006001”,
“status”: “Queued”,
“created_time”: “Feb 04, 2025 10:46 AM”,
“created_by”: {
“zuid”: “92747509”,
“is_confirmed”: false,
“email_id”: “amelia.b@zylker.com”,
“first_name”: “Amelia”,
“last_name”: “Burrows”,
“user_type”: “SuperAdmin”,
“user_id”: “28674000000016006”
},
“deployment_id”: “2289000000004006”,
“build_meta”: {
“event_type”: “push”,
“commit_id”: “18f6b8ef0d2586718a015be07701bd6ba486a18f”,
“commit_message”: “Initial commit”,
“commit_url”: “https://api.github.com/repos/ameliab-13966/nextjs-mongo-db/commits/18f6b8ef0d2586718a015be07701bd6ba486a18f",
“timestamp”: “2024-12-23T07:22:39Z”,
“author_name”: “amelia-b-13966”,
“repo_id”: “907257721”,
“repo_name”: “nextjs-mongo-db”,
“web_url”: “https://github.com/ameliab-13966/nextjs-mongo-db",
“ssh_url”: “git@github.com:ameliab-13966/nextjs-mongo-db.git”,
“http_url”: “https://github.com/ameliab-13966/nextjs-mongo-db.git",
“provider”: “Github”,
“repo_slug”: “nextjs-mongo-db”
}
}
}
Yes
No
Thank you for your feedback!
Send your feedback to us