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 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.