Módulos

Un módulo suma a tu espacio una capacidad nueva: un catálogo, el cobro de pedidos, la conexión con tu CRM, fichas con datos de la web… Cada uno tiene sus propias rutas en la API, con la misma clave, los mismos límites y los mismos créditos que el resto.

También se manejan desde la consola: en el Estudio de tu espacio, cada módulo activo tiene su panel. Lo que haces allí y lo que haces por la API es lo mismo.

Cómo se llama a un módulo

Todas las rutas de un módulo cuelgan de la misma raíz: el id del módulo y el id del espacio.

https://bentho.org/api/mod/{modulo}/{espacio}/{ruta}

curl https://bentho.org/api/mod/productos/mi-espacio/productos \
  -H "Authorization: Bearer $BENTHO_KEY"

• {modulo} es el id del módulo (la columna ID del catálogo), no su nombre: landing, no «Landings».
• {espacio} es el id del espacio, el mismo de las rutas de preguntar y de documentos.
• El cuerpo, la respuesta y los errores propios de cada ruta están en su ficha. JSON salvo que la ficha diga otra cosa (subidas de archivos o descargas).

Qué módulos tiene tu espacio

GET /api/companies devuelve los espacios a los que llega tu clave; cada uno trae en modules los ids de los módulos que tiene activos. Un módulo responde solo en los espacios donde está activo: en los demás, cada ruta da 403.

{
  "companies": [
    {
      "id": "mi-espacio",
      "name": "Tienda Aurora",
      "modules": ["rag-chat", "documents", "productos", "facturacion", "fuentes"]
    }
  ]
}

Cada espacio tiene un cupo de módulos. Míralo en GET /api/companies/{espacio}/limite y activa o quita módulos con PATCH /api/companies/{espacio}/modules (clave escribe), o desde la consola.

Permisos

• Leer (GET) vale con cualquier clave.
• Crear, cambiar o borrar (POST, PUT, PATCH, DELETE) pide una clave escribe; con una lee, 403.
• Excepción: conversar con un módulo (por ejemplo, mandarle un mensaje a Ventas) es consultar, y vale con una clave lee. Cada ficha dice qué permiso pide.

Créditos

Solo gastan créditos las rutas que ponen a trabajar al asistente: conversar, armar fichas, crear landings… Leer, configurar y gestionar el catálogo, los pedidos o las tarifas no gasta. Sin créditos, esas rutas responden 402 y las demás siguen funcionando; cancelar un trabajo en curso nunca se corta. Estas son las que gastan:

Cuánto llevas gastado en un módulo, en créditos, lo dice GET /api/mod/{modulo}/{espacio}/consumo en los módulos que la tienen; el total de la cuenta, la bolsa de créditos.

Errores comunes a todos los módulos

Además de los de cada ficha y de los generales de la API (401, 429…):

Catálogo

Cada módulo tiene su guía («cómo funciona») y una ficha por ruta. En el mapa (tecla M) se despliegan las rutas del módulo en el que estás.