Endpoints de API.

Esta página lista cada ruta que registra DXPR Builder en dxpr_builder.routing.yml, con los métodos HTTP, los requisitos de acceso, los parámetros de petición y las formas de respuesta implementados en los controladores. El JavaScript del editor es el cliente previsto de los endpoints AJAX; nada de esta página es una API pública estable, y los nombres de parámetro pueden cambiar entre versiones.

Requisitos de acceso

Las rutas usan tres tipos de requisito. Una ruta puede combinarlos.

Qué significa «cuenta facturable»

DxprBuilderBillableUserAccessCheck permite el acceso cuando DxprBuilderLicenseService::isBillableUser() devuelve verdadero para la cuenta actual. Ese método devuelve falso para cuentas bloqueadas y para cuentas cuyo campo dxpr_user_is_disavowed tiene valor (una persona administradora excluye a una cuenta de la edición en la página Licencias de usuario). Si no, devuelve verdadero para la cuenta 1 y para cualquier cuenta que tiene el permiso edit with dxpr builder. En resumen: una cuenta facturable es una cuenta activa y no excluida que puede editar con DXPR Builder, y el servicio de licencias cuenta estas cuentas en tu clave de producto.

Métodos HTTP

Donde una ruta declara methods, solo esos métodos se enrutan. Donde no, la ruta acepta cualquier método (el MethodFilter de Drupal solo filtra rutas que declaran métodos). Las tablas de abajo indican el método que usa en realidad el JavaScript del editor cuando se ve en el código.

Endpoints AJAX del editor

URL de token CSRF

La petición debe llevar la cabecera X-Requested-With: XMLHttpRequest; sin ella el controlador devuelve HTTP 403 con el cuerpo JSON {"error": "Invalid request"}.

Respuesta: una cadena JSON con la URL del manejador AJAX principal y un parámetro de consulta token. La URL es una ruta desde la raíz del sitio (ruta base incluida, sin host). El JavaScript envía cada operación del constructor a esta URL.

Manejador AJAX principal

El campo action del cuerpo POST elige la operación. Cada operación y sus parámetros se listan en Operaciones del manejador AJAX principal. Cuando falta action o es desconocido, el controlador devuelve un AjaxResponse de Drupal vacío sin comandos. La mayoría de operaciones que reverifican el estado facturable de la cuenta devuelven la misma respuesta vacía cuando falla esa revisión; las tablas indican las dos excepciones.

Chat de IA

El cuerpo de la petición es JSON. El controlador pasa la petición al proveedor dxpr del módulo ai de Drupal, así que ninguna clave de API llega al navegador. Antes de la llamada combina los dominios del ajuste ai_output_allowed_domains en el filtro de nombres de host del módulo ai, cuando ese servicio existe. Un valor de * pone el filtro en confianza plena. El filtro se restaura después.

Respuestas:

Generación de imágenes con IA

Respuestas:

Edición de imágenes con IA

Respuestas:

Subida de archivos

El controlador clasifica cada archivo por la primera parte de su MIME de cliente en <default scheme>://dxpr_builder_images, dxpr_builder_videos o dxpr_builder_files. Una imagen necesita una extensión de los tipos MIME image/gif, jpg, jpeg, png, webp, avif o svg. Un vídeo necesita uno de video/webm, ogv, ogg, mp4 o quicktime (por ejemplo .mov). El límite de tamaño es el máximo de subida de PHP. Un archivo con el mismo nombre e idéntico contenido SHA-256 que un archivo gestionado existente que la cuenta puede ver se reutiliza en lugar de guardarse de nuevo. Cuando el módulo media está instalado y existe un tipo de medio llamado image, media_image, video o media_video, se crea una entidad de medio publicada (o se reutiliza) para el archivo. El uso del archivo se registra en el módulo dxpr_builder.

Respuestas:

Diálogo de biblioteca de medios

El tipo de medio ofrecido depende del ajuste media_browser: media_library usa el tipo de medio image o video directamente; media_library_acquia_dam usa acquia_dam_image_asset o acquia_dam_video_asset cuando ese tipo de medio existe.

Respuestas:

Validador de enlaces de ayuda

Respuesta: un array JSON. [true] cuando una petición HEAD al enlace (sin seguir redirecciones) devuelve 200; [false] cuando el cliente HTTP lanza una excepción; [] en cualquier otro caso, incluido un parámetro ausente, una URL no coincidente o un estado distinto de 200.

Sugerencias de enlaces de entidad

Los bundles son los que tienen ckeditor5_link_suggestions activado en su info de bundle; cuando no hay ninguno configurado, se buscan todos los bundles de nodo. Hasta 100 entidades por tipo de entidad coinciden con una búsqueda CONTAINS en los plugins de selección de referencia de entidad del núcleo.

Respuesta: {"suggestions": [...]} con caché privada y una edad máxima de 300 segundos. Cada sugerencia tiene description, entity_type_id, entity_uuid, group, label y path. Cuando q no coincide con nada, el array guarda una sola sugerencia de enlace manual con description, label (la entrada en minúsculas) y path (la entrada cuando es una URL válida; si no, una cadena vacía). Cuando q está vacío, suggestions es un array vacío.

Ajustes de editor de la cuenta

El editor envía esta petición cuando una cuenta cambia sus propios ajustes de editor, por ejemplo en Ajustes del editor. Los valores se guardan con la cuenta de usuario en user.data, módulo dxpr_builder.

Respuestas:

Operaciones del manejador AJAX principal

Todas las operaciones van a /dxpr_builder/ajax con el parámetro de consulta de token obtenido de /dxpr_builder/csrf. El nombre de la operación se envía en el campo action del cuerpo POST; todos los demás parámetros son campos del cuerpo POST salvo que se indique lo contrario. La columna «Reverifica facturable» marca las operaciones que llaman a isBillableUser() de nuevo dentro del switch. Cuando falla esa revisión devuelven el AjaxResponse vacío descrito arriba, salvo que la fila diga lo contrario.

Sesión y acceso

Contenedores (campos mostrados con el formateador de DXPR Builder)

dxpr_save_container hace lo siguiente:

1. Decodifica htmlContent: XOR de cada byte con 7, luego decodificación URL.
2. Escribe el resultado en el primer delta del campo nombrado.
3. Crea una revisión por defecto nueva con el mensaje de registro Saved with DXPR builder cuando el tipo de entidad admite revisiones.
4. Quita cualquier bloqueo de contenido de la entidad.
5. Actualiza block_revision_id en las secciones de Layout Builder que referencian el bloque en línea guardado.
6. Incrementa el valor de estado dxpr_builder.saves_count.

El guardado solo ocurre cuando la cuenta tiene acceso update a la entidad. Sin él, la operación aún devuelve la respuesta de éxito de cadena vacía.

Elementos CMS (bloques y vistas)

En ambas operaciones que devuelven settings, css y js son etiquetas de recursos mostradas que aún no están en la página, y settings es el objeto drupalSettings decodificado, o una cadena vacía cuando no hay ninguno.

Plantillas de página

Plantillas de usuario

El nombre de sistema deriva de name pasándolo a minúsculas y cambiando cada grupo de caracteres fuera de a-z0-9_ por un guion bajo. type recurre al atributo data-azb del marcado cuando una plantilla guardada no tiene tipo.

Imágenes

Bloqueos de contenido

Páginas de administración

Todas estas rutas aceptan cualquier método (sin clave methods). Las rutas que llevan {...} toman el ID de entidad de configuración, o el ID de migración para {migration_id}.

¿Qué sigue?

• Referencia de configuración para los ajustes que controlan el navegador de medios y el comportamiento de IA usados por estos endpoints.
• API de PHP para los servicios que llaman los controladores.
• API de hooks para los hooks que dejan que otros módulos cambien el comportamiento del constructor.