Configura y utiliza la API de Tulip para interactuar con Tulip desde otros sistemas.
This article assumes previous experience with APIs.
Tulip interactúa con las API de muchos otros sistemas a través de conectores. Mediante los conectores, una aplicación de Tulip puede iniciar una consulta HTTP o SQL.
En otros casos, es posible que desees permitir que un sistema externo consulte datos que solo existen en Tulip. Es posible comunicarse con Tulip desde sistemas externos utilizando la API de Tulip. Este artículo te guiará a través de la configuración y las pruebas de la API de Tulip.
La API de Tulip resulta útil para integrar estos sistemas externos con Tulip de diversas formas. Actualmente, la API solo funciona con las tablas de Tulip. Esto puede incluir actualizar un registro de una tabla con nueva información, crear una tabla u obtener el recuento de registros de una tabla.
Funcionalidad de la API de estaciones
La API de estaciones puede ayudarte a gestionar e incorporar nuevas estaciones rápidamente. Su funcionalidad general consiste en crear, listar y modificar estaciones, grupos de estaciones e interfaces (antes denominadas «dispositivos de visualización»). Más información aquí.
Por ejemplo, puedes escribir un script que te permita enviar automáticamente un enlace para configurar una nueva interfaz cada vez que incorpores a un nuevo usuario.
Guía paso a paso
Prior to r383, Service Accounts were called "API Tokens".
Configurar la API de Stations
Consulta este artículo para ver cómo configurar una cuenta de servicio.
If you have a Service Account already set up, you may use that API Key and Secret
- En la configuración de la cuenta, selecciona la pestaña «API de Tulip ».
- Haz clic en «Crear cuenta de servicio».
- Asigna un nombre a tu cuenta de servicio.
- En «Ámbitos», selecciona
«estaciones: lectura» y«estaciones: escritura»:
Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
- Haz clic en «Guardar».
Utilizar la API de estaciones
Una vez configurada la API de Stations, puedes crear una estación. En este ejemplo se utiliza Postman para realizar la creación.
- Añade tu punto final de la API a la solicitud POST.
- En «Encabezados», añade el encabezado «Auth».
- En «Body», configura la solicitud para que admita el objeto JSON. El formato genérico de esta solicitud es el siguiente:
Al crear la solicitud, incluye el espacio de trabajo. Ejemplo:<nombre-de-tu-instancia>.tulip.co/api/stations/v1/w/1/stations. En este ejemplo se accede al punto final «stations». Si no tienes un espacio de trabajo, debes establecerlo en 1.
- Pulsa «Enviar» para ejecutar la solicitud y recibirás una respuesta 200 que indica que se ha realizado correctamente.
Para verificarlo, ve a la página «Estaciones», en la pestaña «Planta de producción », y comprueba que se ha creado la estación.
