Cómo utilizar la API de tablas

Configura y utiliza la API de Tulip para interactuar con Tulip desde otros sistemas.

:::(Info) (Contenido Avanzado)Este artículo asume experiencia previa con APIs:::

Tulip interactúa con muchas APIs de otros sistemas a través de conectores. Usando conectores, una aplicación Tulip puede iniciar una consulta HTTP o SQL.

En otros casos, es posible que desees permitir que un sistema externo consulte datos que sólo existen dentro de Tulip. Es posible comunicarse con Tulip desde sistemas externos utilizando la API de Tulip. Este artículo le guiará a través de la configuración y prueba de la API de Tulip.

El Tulip API es útil para integrar estos sistemas externos con Tulip, a través de Tulip Tables. Esto incluye la actualización de un registro de la tabla con nueva información, la creación de una tabla, u obtener el recuento de registros en una tabla.

Ejemplos

Los siguientes ejemplos muestran el proceso para realizar peticiones a la API de Tulip. Estos ejemplos utilizan Postman para realizar las peticiones desde Tulip.

Obtener nombres e información de tablas

Esta petición GET permite al sistema externo recuperar los IDs y la información de las columnas de todas las tablas dentro de la instancia de Tulip. Esto puede ser útil como método para encontrar una Tabla de interés para configurar una petición POST.

En Postman, establece la Autorización como Basic Auth, e introduce la Clave API y el Secreto.

Ahora, la solicitud tiene que ir al lugar correcto. En Tulip, busca la solicitud que quieres hacer en la documentación de la API. En este caso, la solicitud es para obtener toda la información de la tabla.

Para obtener la URL de la petición, ejecuta el botón Ejecutar, y comprueba la información de la petición.

Esta URL de solicitud puede ser utilizada como la URL del servidor para procesar la solicitud GET de Postman.

Haga clic en Enviar, y la solicitud devolverá toda la información de las tablas.

Crear un Registro de Tabla

Usando un POST, y el ID de Tabla encontrado arriba, se puede crear un Registro de Tabla desde el sistema externo. La Autorización y el Encabezado permanecerán iguales, pero el URL de la Solicitud será un poco diferente.

Primero, determine la Tabla en la que desea crear un registro. La URL de la solicitud siempre se ajustará a la siguiente estructura:

:::(Info) (NOTA) Si utiliza una clave de API global, deberá especificar el espacio de trabajo. Si su clave de API tiene un ámbito de espacio de trabajo, es opcional.:::

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records

Una vez introducida, la solicitud también necesitará un cuerpo para procesar el POST correctamente. El esquema de las columnas se indica más arriba, en la sección Pruebas, y puede consultarse en la documentación de la API. La única columna que es totalmente necesaria para que esto tenga éxito es la columna ID. Cualquier otra columna que no se añada se almacenará como nula en el registro de la tabla en el momento de su creación. Añada este contenido como cuerpo de la solicitud.

Al enviar la solicitud, Postman verifica que se ha creado el registro.

¿Ha encontrado lo que buscaba?

También puedes dirigirte a community.tulip.co para publicar tu pregunta o ver si otras personas se han enfrentado a una pregunta similar.