Trowel Academy
Acciones

#Referencia OpenAPI

El contrato generado se publica en:

/swagger/public-v1/swagger.json

El documento se llama public-v1 y contiene únicamente operaciones marcadas como públicas. No necesitas conocer esa ruta para usar la referencia del portal de desarrolladores, que presenta el contrato por áreas y permite buscar y probar operaciones.

El portal de desarrolladores agrupa las operaciones en el menú lateral. Dentro de Base de datos, la estructura es esta:

  • Empresas
    • Clientes
    • Proveedores
  • Productos
    • Productos
    • Precios de proveedor
    • Cambios de productos
  • Proyectos
    • Proyectos
    • Series de numeración
  • Partes de trabajo
  • Repasos

Despliega cada nivel hasta llegar a la operación que quieras consultar. El buscador también encuentra operaciones dentro de grupos contraídos y muestra la rama que las contiene.

Si abres directamente la URL de una operación, el portal despliega sus grupos y marca la operación activa. La misma jerarquía está disponible con teclado y se adapta al ancho de la pantalla en móvil.

Consulta Productos, proveedores y precios para el protocolo de sincronización y ejemplos. Consulta Clientes para mantener clientes mediante el mismo modelo de empresas que los proveedores. Consulta Proyectos y series para crear, editar, borrar o clonar proyectos.

Consulta Partes de trabajo para gestionar partes, estados, empleados, tipos de hora, campos personalizados e imágenes.

Usa OpenAPI o el portal para consultar las rutas, los esquemas, las restricciones y las respuestas vigentes. Los endpoints de /api/services/app y /api/client/v1 no forman parte del contrato público.

Antes de actualizar una integración, compara el documento del entorno con la versión que usaste para desarrollarla. Los cambios incompatibles requieren otra versión mayor de la URL.

⌕Esc

Escribe para buscar en toda la Academy.