Prueba unitaria de la API de Tulip

Prev Next

Objetivo

Este artículo resume cómo está estructurada y construida la API de Tulip.

¿Para qué sirve la prueba unitaria de la API de Tulip?

Permite probar algunas de las funciones más utilizadas de la API de Tulip. Funciones incluidas en la aplicación:

  • Listar tablas de Tulip
  • Listar registros de una tabla de Tulip
  • Crear un registro en una tabla de Tulip
  • Contar los registros de una tabla de Tulip
  • Eliminar un registro de una tabla de Tulip
  • Actualizar un registro de una tabla Tulip
  • Eliminar todos los registros de una tabla Tulip
  • Firmar URL

Tabla utilizada en la prueba unitaria

Para probar las funciones de la API de la tabla de Tulip, el usuario necesita una tabla de prueba, concretamente la tabla de ejemplo de la API de Tulip.

Estructura de la aplicación

Feature rename

Prior to r383, Service Accounts were called "API Tokens".

Hay un menú en la parte izquierda de cada paso.

En los pasos «Introducción» y «Configurar conexión», el usuario puede informarse sobre la finalidad de la aplicación y encontrar instrucciones sobre cómo configurar la conexión entre el conector de la API de Tulip y su instancia.

Intro

Si tu instancia no tiene habilitados los espacios de trabajo, ve a «Configuración de la cuenta» > «API de Tulip» para generar tu cuenta de servicio. En este caso, no es necesario que incluyas /w/DEFAULT en tu punto final de la API; es decir, para obtener tablas, tu punto final será: URL base + api/v3/tables

Si tienes los espacios de trabajo habilitados y utilizas una cuenta de servicio de API global (que se encuentra en «Configuración de la cuenta» > «API de Tulip»), tendrás que definir el espacio de trabajo en tu punto final de la API; es decir, para obtener tablas, tu punto final será -URL BASE + api/v3/w/<workspaceID>/tables. Obtén más información al respecto aquí: https://support.tulip.co/apidocs/introduction#workspaces

Si tienes los espacios de trabajo activados y utilizas una cuenta de servicio con ámbito de espacio de trabajo (que se encuentra en «Configuración del espacio de trabajo» > «API de Tulip»), no es necesario que definas el espacio de trabajo en tu punto final de la API; es decir, para obtener tablas, tu punto final será:URL BASE + api/v3/tables

config.png

En el paso «Obtener tablas», la función del conector se ejecuta al pulsar el botón «Obtener tablas» para mostrar todas las tablas de la instancia. El usuario puede seleccionar una tabla de la tabla interactiva de la izquierda y ver sus detalles a la derecha.Get Tables

En el paso «Crear registro», el usuario puede crear un nuevo registro rellenando los campos de entrada. Al hacer clic en el botón «Crear un registro» y una vez rellenados todos los campos, el nuevo registro se puede ver en la tabla interactiva de la derecha. Create Record

En el paso «Obtener registros », los registros de la tabla de ejemplo de la API de Tulip se muestran al pulsar el botón «Obtener registros». El usuario puede seleccionar un registro de la tabla interactiva de la izquierda y ver sus detalles a la derecha.Get Recs

En el paso «Contar registros», la función del conector se ejecuta al pulsar el botón, y el número de registros se muestra a la derecha.Count recs

En el paso «Actualizar registro», el usuario puede seleccionar el ID del registro que desea actualizar y rellenar los campos de entrada que se van a modificar. En cuanto se hace clic en el botón «Actualizar registro», el registro actualizado se puede ver a la derecha.Update recs

En el paso «Eliminar registro », el usuario debe seleccionar un registro de la tabla interactiva de la izquierda. Al hacer clic en el botón «Eliminar registro », el registro se elimina de la tabla de ejemplo.

Delete Recone

En el paso «Eliminar todos los registros », al hacer clic en el botón «Eliminar todos los registros », se eliminan todos los registros de la tabla de ejemplo.

Delete all recs

En el paso «Firmar URL», el usuario puede introducir una URL y firmarla. Una vez firmada la URL, la URL firmada se puede ver en el panel de la derecha. sign url