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}

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.