Acciones
#Trabajar con el portal de desarrolladores
El portal de desarrolladores contiene la referencia interactiva de la API pública V1. Desde allí puedes consultar el contrato, generar ejemplos y ejecutar peticiones contra un entorno de Trowel.
#Conectar con un entorno
- Abre cualquier operación de la referencia.
- Despliega Conectar con un entorno.
- Introduce una API key completa que empiece por
trowel_live_. - Pulsa Obtener token.
En producción, el portal ya tiene configurado el destino y no muestra la URL del API. En una instalación local o de desarrollo también aparece el campo URL del API para elegir el entorno de pruebas.
La API key y el token permanecen en la memoria de la página. No se guardan en localStorage, sessionStorage, cookies ni en la URL. Vaciar memoria elimina la conexión. Al cerrar o recargar la página también se pierde.
Para hacer pruebas de escritura usa un entorno no productivo y una credencial con los permisos mínimos necesarios.
#Buscar y probar una operación
La navegación agrupa los endpoints por área. También puedes buscar por nombre, método o ruta.
- Abre la operación.
- Revisa el scope indicado junto a la ruta.
- Completa los parámetros de ruta, filtros o body de entrada.
- Revisa la petición generada.
- Pulsa Ejecutar petición.
Las operaciones que modifican datos piden confirmación antes de enviarse. La respuesta muestra el estado HTTP, el tiempo y el identificador de correlación. Si la respuesta está paginada y contiene un cursor, Usar siguiente cursor prepara la petición siguiente.
#Copiar CURL, subir y descargar archivos
Copiar CURL genera un comando equivalente para ejecutarlo fuera del portal. El valor YOUR_ACCESS_TOKEN es un marcador: sustitúyelo por un token válido y evita guardarlo en el historial del terminal.
Los endpoints de carga permiten elegir los archivos requeridos. En las respuestas binarias, como fotos o imágenes de partes, el portal ofrece un enlace con el nombre de archivo devuelto por la API para descargar el contenido.
#Comprobar errores de autenticación
El panel de pruebas permite ejecutar una petición sin bearer token o con uno inválido para comprobar las respuestas 401. Un token válido sin el scope requerido devuelve 403.
La referencia del portal es la fuente para rutas, parámetros, modelos y respuestas. Las guías de Academy explican cómo preparar la integración y los flujos propios de cada área.