Endpoint API.

Questa pagina elenca ogni route registrata da DXPR Builder in dxpr_builder.routing.yml, con i metodi HTTP, i requisiti di accesso, i parametri di richiesta e le forme di risposta come implementati nei controller. Il JavaScript dell’editor è il client previsto per gli endpoint AJAX; niente in questa pagina è una API pubblica stabile e i nomi dei parametri possono cambiare tra le versioni.

Requisiti di accesso

Le route usano tre tipi di requisito. Una route può combinarli.

Cosa significa "utente fatturabile"

DxprBuilderBillableUserAccessCheck consente l’accesso quando DxprBuilderLicenseService::isBillableUser() restituisce true per l’account corrente. Quel metodo restituisce false per gli account bloccati e per gli account il cui campo dxpr_user_is_disavowed è impostato (un amministratore esclude un utente dalla modifica nella pagina User Licenses). Altrimenti restituisce true per l’utente 1 e per ogni account che ha il permesso edit with dxpr builder. In breve: un utente fatturabile è un account attivo e non escluso autorizzato a modificare con DXPR Builder, e il servizio licenze conta questi account sulla tua chiave prodotto.

Metodi HTTP

Dove una route dichiara methods, vengono instradati solo quei metodi. Dove non li dichiara, la route accetta qualsiasi metodo (il MethodFilter di Drupal filtra solo le route che dichiarano metodi). Le tabelle sotto indicano il metodo usato davvero dal JavaScript dell’editor quando è visibile nel sorgente.

Endpoint AJAX dell’editor

URL del token CSRF

La richiesta deve portare l’header X-Requested-With: XMLHttpRequest; senza di esso il controller restituisce HTTP 403 con il corpo JSON {"error": "Invalid request"}.

Risposta: una stringa JSON con l’URL del gestore AJAX principale e un parametro di query token. L’URL è un percorso dalla radice del sito (base path incluso, senza host). Il JavaScript invia ogni operazione del builder a questo URL.

Gestore AJAX principale

Il campo action del corpo POST seleziona l’operazione. Ogni operazione e i suoi parametri sono elencati in Operazioni del gestore AJAX principale. Quando action manca o è sconosciuto, il controller restituisce un AjaxResponse Drupal vuoto senza comandi. La maggior parte delle operazioni che ricontrollano lo stato di utente fatturabile restituisce la stessa risposta vuota quando quel controllo fallisce; le tabelle notano le due eccezioni.

Chat AI

Il corpo della richiesta è JSON. Il controller inoltra la richiesta al provider dxpr del modulo Drupal ai, così nessuna chiave API raggiunge il browser. Prima della chiamata unisce i domini dell’impostazione ai_output_allowed_domains al filtro hostname del modulo ai, quando quel servizio esiste. Un valore di * imposta il filtro su piena fiducia. Il filtro viene ripristinato dopo.

Risposte:

Generazione di immagini AI

Risposte:

Modifica di immagini AI

Risposte:

Caricamento file

Il controller smista ogni file in base alla prima parte del suo MIME client in <schema predefinito>://dxpr_builder_images, dxpr_builder_videos o dxpr_builder_files. Un’immagine richiede un’estensione dei tipi MIME image/gif, jpg, jpeg, png, webp, avif o svg. Un video ne richiede una tra video/webm, ogv, ogg, mp4 o quicktime (per esempio .mov). Il limite di dimensione è il massimo di caricamento di PHP. Un file con lo stesso nome e contenuto SHA-256 identico a un file gestito esistente che l’utente può vedere viene riusato invece di essere salvato di nuovo. Quando il modulo media è installato ed esiste un tipo di media chiamato image, media_image, video o media_video, viene creata (o riusata) per il file un’entità media pubblicata. L’uso del file è registrato sotto il modulo dxpr_builder.

Risposte:

Finestra della libreria multimediale

Il tipo di media offerto dipende dall’impostazione media_browser: media_library usa direttamente il tipo di media image o video; media_library_acquia_dam usa acquia_dam_image_asset o acquia_dam_video_asset quando quel tipo di media esiste.

Risposte:

Validatore dei link di aiuto

Risposta: un array JSON. [true] quando una richiesta HEAD al link (senza seguire redirect) restituisce 200; [false] quando il client HTTP solleva un’eccezione; [] in ogni altro caso, inclusi parametro mancante, URL non corrispondente o stato diverso da 200.

Suggerimenti di link a entità

I bundle sono quelli con ckeditor5_link_suggestions attivo nelle loro info bundle; quando nessuno è configurato, si cercano tutti i bundle nodo. Fino a 100 entità per tipo di entità vengono abbinate con una ricerca CONTAINS tramite i plugin di selezione reference di entità del core.

Risposta: {"suggestions": [...]} con cacheabilità privata e un’età massima di 300 secondi. Ogni suggerimento ha description, entity_type_id, entity_uuid, group, label e path. Quando q non trova nulla, l’array contiene un unico suggerimento di link manuale con description, label (l’input in minuscolo) e path (l’input quando è un URL valido, altrimenti una stringa vuota). Quando q è vuoto, suggestions è un array vuoto.

Impostazioni editor dell’utente

L’editor invia questa richiesta quando un utente cambia le proprie impostazioni editor, per esempio in Editor settings. I valori sono salvati con l’account utente in user.data, modulo dxpr_builder.

Risposte:

Operazioni del gestore AJAX principale

Tutte le operazioni vanno a /dxpr_builder/ajax con il parametro di query token ottenuto da /dxpr_builder/csrf. Il nome dell’operazione è inviato nel campo action del corpo POST; tutti gli altri parametri sono campi del corpo POST salvo indicazione diversa. La colonna "Ricontrolla utente fatturabile" segna le operazioni che richiamano isBillableUser() di nuovo dentro lo switch. Quando quel controllo fallisce restituiscono la AjaxResponse vuota descritta sopra, salvo indicazione diversa nella riga.

Sessione e accesso

Contenitori (campi resi con il formatter DXPR Builder)

dxpr_save_container fa quanto segue:

1. Decodifica htmlContent: XOR di ogni byte con 7, poi URL-decode.
2. Scrive il risultato nel primo delta del campo indicato.
3. Crea una nuova revisione predefinita con il messaggio di log Saved with DXPR builder quando il tipo di entità ammette revisioni.
4. Rimuove ogni blocco di contenuto per l’entità.
5. Aggiorna block_revision_id nelle sezioni Layout Builder che referenziano il blocco inline salvato.
6. Incrementa il valore di stato dxpr_builder.saves_count.

Il salvataggio avviene solo quando l’utente ha accesso update all’entità. Senza di esso, l’operazione restituisce comunque la risposta di successo a stringa vuota.

Elementi CMS (blocchi e viste)

In entrambe le operazioni che restituiscono settings, css e js sono tag di asset resi non già presenti nella pagina, e settings è l’oggetto drupalSettings decodificato, o una stringa vuota quando non ce ne sono.

Modelli di pagina

Modelli utente

Il machine name deriva da name minuscolizzandolo e sostituendo ogni sequenza di caratteri fuori da a-z0-9_ con un underscore. type ripiega sull’attributo data-azb nel markup quando un modello salvato non ha tipo.

Immagini

Blocchi di contenuto

Pagine admin

Tutte queste route accettano qualsiasi metodo (nessuna chiave methods). I percorsi con {...} prendono l’ID dell’entità di configurazione, o l’ID di migrazione per {migration_id}.

E adesso?

• Riferimento alla configurazione per le impostazioni che controllano il browser multimediale e il comportamento AI usati da questi endpoint.
• PHP API per i servizi chiamati dai controller.
• Hooks API per gli hook che permettono ad altri moduli di modificare il comportamento del builder.