This article assumes previous experience with APIs.
Consulta los artículos sobre tablas, operadores y máquinas para ver cómo configurar la clave de la API.
Utiliza los conectores de Tulip para probar la API de Tulip
Prior to r383, Service Accounts were called "API Tokens".
Lee cómo configurar un conector y cómo configurarlo utilizando la cuenta de servicio de la API que has configurado (consulta este artículo sobre cómo configurar una cuenta de servicio).
Una vez que hayas configurado tu conector, haz clic en «Crear función». En este ejemplo, veremos cómo obtener registros de una tabla.
En primer lugar, debe crear una solicitud utilizando los métodos GET, POST, PUT, HEAD, PATCH o DELETE y, a continuación, especificar la URL concreta a la que desea enviar la solicitud (consulte aquí para obtener más información sobre las capacidades de nuestra API y ) .
If you are using a global Service Account, you need to specify the workspace. If your Service Account is workspaced scoped, it is optional.
https://(tu_nombre_de_instancia_aquí).tulip.co/api/v3/w/(espacio_de_trabajo)/tables/(ID_de_la_tabla)/records
Asegúrate de añadir tu autenticación (de la propia cuenta de servicio), los encabezados de la solicitud (si es necesario) y los parámetros de consulta (ya sea en la propia URL o en los parámetros de consulta; consulta cómo configurar los parámetros de consulta para obtener más información).
Además, puedes especificar cualquier entrada o salida que la función del conector pueda necesitar para enviar información a una aplicación o automatización.
Uso de Postman para probar la API de Tulip
A continuación se explica cómo crear un operador. En este caso, el ejemplo utilizará Postman para llevar a cabo la creación.
En primer lugar, añade tu punto final de la API a la solicitud POST.
A continuación, en «Autorización», selecciona «Autenticación básica» e introduce la clave de la API como nombre de usuario y el secreto de la API como contraseña.
En «Headers», añade el encabezado «Auth».
En el «Cuerpo», configura la solicitud para que admita el objeto JSON. El formato genérico para esta solicitud es el siguiente:
{"role": "operator","name": "string","badge_id": "string"}
El resultado será algo parecido a esto:
Pulsa «Enviar» para ejecutar la solicitud y recibirás una respuesta 201 que indica que se ha realizado correctamente. Para verificarlo, puedes consultar tu lista de usuarios en «Configuración» y confirmar que el usuario se ha creado correctamente.
Si la solicitud ha fallado, asegúrate de que la clave y el secreto sean correctos. Para obtener más información sobre códigos de respuesta específicos, consulta la sección «Documentación de la API» en la página de la API de Tulip.
Uso de la documentación de la API para probar la API de Tulip
En la configuración de tu espacio de trabajo o de tu cuenta, ve a «API de Tulip». Desde allí, haz clic en «Más información» junto a la opción «Crear cuenta de servicio».
Esto te llevará a una página que te permite probar la API con la clave generada. También ofrece documentación y ejemplos de cuerpos de solicitud para diversos usos.
Esta página también contiene la URL del servidor necesaria para configurar las solicitudes de la API desde sistemas externos. Para familiarizarte con la API, haz clic en el botón «Autorizar».
Este botón te proporcionará más información sobre la configuración de la API con fines de prueba. En los campos, introduce lo siguiente:
- Nombre de usuario: Clave de la API
- Contraseña: Secreto
Haz clic en «Autorizar» y podrás empezar a probar algunas solicitudes HTTP habituales para las tablas.
Cada una de las opciones de esta página se puede desplegar y probar. Cada solicitud proporciona información útil sobre las respuestas correspondientes.
En esta página también hay información sobre los esquemas de algunos de los componentes de Tulip. Por ejemplo, para crear un registro en una tabla, resulta útil conocer el formato JSON adecuado para cada columna. A continuación se muestra un ejemplo de esquema para las columnas:
