Cómo utilizar la API de tablas
  • 04 Nov 2023
  • 5 Minutos para leer
  • Colaboradores

Cómo utilizar la API de tablas


Article Summary

Propósito

Configurar y utilizar la API de Tulip para interactuar con Tulip desde otros sistemas.

Nota: Artículo avanzado.

Asume experiencia previa con APIs.

:::(Info) (NOTA) Artículo avanzado: 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 pruebas de la API de Tulip.

La API de Tulip es útil para integrar estos sistemas externos con Tulip de muchas maneras. La API actualmente sólo funciona con Tulip Tables Esto podría incluir la actualización de un registro de la tabla con la nueva información, la creación de una tabla, o conseguir el recuento de registros en una tabla.

Añadir una API

Navega a la página de Configuración de tu cuenta de Tulip.

En el menú Configuración, seleccione Tokens API.

Esta página le permite configurar "API Tokens", que son configuraciones de API equipadas con una API Key, un secreto y una cabecera de autorización. Para añadir un token de API, seleccione el botón Añadir token de API en la parte superior derecha de esta página. Una vez seleccionado, configure el token de API como desee.

Asigne un nombre al token de API y defina los ámbitos que podrá ejecutar. En este ejemplo, el token de API puede leer de las tablas Tulip y también escribir en ellas. Los tokens de API pueden archivarse si no están en uso.

Al hacer clic en Crear, se proporcionará la información de la API. Asegúrate de guardar esta información, ¡no se puede acceder a ella de nuevo!

Esta información se puede utilizar ahora para configurar una conexión a la API de Tulip.

Probar la API

Cierra la ventana emergente de información y navega hasta el botón Documentación de la API, junto a la opción Crear token de API.

Esto te llevará a una página que permite probar la API con la clave creada. También proporciona documentación, y da ejemplos para solicitar cuerpos para varios usos.

Esta página también contiene la URL del servidor necesaria para configurar las peticiones API desde sistemas externos. Para familiarizarse con la API, haga clic en el botón Autorizar.

Este botón le proporcionará más información sobre la configuración de la API con fines de prueba. En los campos, introduzca lo siguiente

  • Nombre de usuario: Clave API
  • Contraseña: Secreto

Haga clic en autorizar, y podrá empezar a probar algunas peticiones HTTP comunes para Tablas.

Cada una de las opciones de esta página puede ampliarse y probarse. Cada petición proporciona información útil sobre las respuestas correspondientes.

Dentro de esta página, también hay información sobre Esquemas para algunos de los componentes de Tulip. Por ejemplo, para crear un registro de tabla, es útil conocer el formato JSON apropiado para cada columna. A continuación se muestra un ejemplo de esquema para columnas:

Consulta con filtros

Los filtros pueden ser muy útiles para extraer sólo los datos que le interesan. Estos filtros a veces pueden ser un poco complicados con su sintaxis. A continuación se describe cómo se forma cada uno en el ejemplo de una solicitud GET de registros, seguido de un ejemplo completo.

Losnombres de los campos personalizados siempre van precedidos de un identificador de cadena de cinco dígitos. Estos se pueden encontrar más fácilmente después de una solicitud GET all para comprobar el verdadero nombre del campo.

  • Ej. "field"="maytq_scrap_count".

Los valores delos argumentos suelen ser sencillos. Si se trata de un valor de texto, asegúrese de ponerlo entre comillas.

  • Ej. "arg":15

Haga coincidir el tipo de función que desea utilizar.

  • Ej. "functionType": "mayorQue"

Una solicitud completa podría tener este aspecto:

https://brian.tulip.co/api/v3/tables/W2HPvyCZrjMMHTiip/records?limit=100&sortBy=\_sequenceNumber&sortDir=asc&filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"}]&filterAggregator=any

Filtros múltiples

En algunos casos, puede tener varios filtros para comprobar en la tabla. En este caso, puede añadir múltiples al objeto filters. Esto podría ser algo como esto

filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"},{"field": "maytq\_scrap\_reason", "arg": "scratch", "functionType": "equal"}].

Ejemplos

Los siguientes ejemplos mostrarán el proceso para realizar peticiones a la API de Tulip. Estos ejemplos utilizarán 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 en 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 solicitud, ejecuta el botón Ejecutar y busca la información de la solicitud.

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

Pulsa 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 la URL de la Solicitud será un poco diferente.

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

https://.tulip.co/api/v3/tables//records

Una vez introducida, la petición 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 verificará 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.


¿Te ha sido útil este artículo?