Pontos de extremidade da API.

Esta página lista todas as rotas que o DXPR Builder regista em dxpr_builder.routing.yml, com os métodos HTTP, requisitos de acesso, parâmetros de pedido e formas de resposta conforme implementados nos controladores. O JavaScript do editor é o cliente previsto para os pontos de extremidade AJAX; nada nesta página é uma API pública estável, e os nomes de parâmetros podem mudar entre lançamentos.

Requisitos de acesso

As rotas usam três tipos de requisito. Uma rota pode combiná-los.

O que significa "utilizador faturável"

DxprBuilderBillableUserAccessCheck permite o acesso quando DxprBuilderLicenseService::isBillableUser() devolve verdadeiro para a conta atual. Esse método devolve falso para contas bloqueadas e para contas cujo dxpr_user_is_disavowed campo está definido (um administrador exclui um utilizador da edição na página User Licenses). Caso contrário, devolve verdadeiro para o utilizador 1 e para qualquer conta que tenha a edit with dxpr builder permissão. Em resumo: um utilizador faturável é uma conta ativa e não excluída com permissão para editar com o DXPR Builder, e o serviço de licenças conta estas contas na sua chave de produto.

Métodos HTTP

Quando uma rota declara methods, só esses métodos são encaminhados. Quando não declara, a rota aceita qualquer método (o MethodFilter do Drupal só filtra rotas que declaram métodos). As tabelas abaixo indicam o método que o JavaScript do editor usa de facto quando isso está visível no código.

Pontos de extremidade AJAX do editor

URL de token CSRF

O pedido tem de transportar o cabeçalho X-Requested-With: XMLHttpRequest; sem ele, o controlador devolve HTTP 403 com o corpo JSON {"error": "Invalid request"}.

Resposta: uma string JSON com o URL do processador AJAX principal e um token parâmetro de consulta. O URL é um caminho desde a raiz do site (caminho base incluído, sem anfitrião). O JavaScript publica todas as operações do construtor neste URL.

Processador AJAX principal

O campo do corpo POST action seleciona a operação. Todas as operações e os seus parâmetros estão listados em Operações do processador AJAX principal. Quando action falta ou é desconhecido, o controlador devolve um Drupal vazio AjaxResponse sem comandos. A maioria das operações que voltam a verificar o estado de utilizador faturável devolve a mesma resposta vazia quando essa verificação falha; as tabelas indicam as duas exceções.

Chat de IA

O corpo do pedido é JSON. O controlador reencaminha o pedido para o dxpr fornecedor do Drupal ai módulo, para nenhuma chave de API chegar ao navegador. Antes da chamada, funde os domínios de ai_output_allowed_domains definição no ai filtro de nome de anfitrião do módulo, quando esse serviço existe. Um valor de * define antes o filtro como confiança total. O filtro é reposto depois.

Respostas:

Geração de imagens por IA

Respostas:

Edição de imagens por IA

Respostas:

Carregamento de ficheiros

O controlador ordena cada ficheiro pela primeira parte do seu tipo MIME de cliente em <default scheme>://dxpr_builder_images, dxpr_builder_videos ou dxpr_builder_files. Uma imagem precisa de uma extensão dos tipos MIME image/gif, jpg, jpeg, png, webp, avif ou svg. Um vídeo precisa de um de video/webm, ogv, ogg, mp4 ou quicktime (por exemplo .mov). O limite de tamanho é o máximo de carregamento do PHP. Um ficheiro com o mesmo nome e conteúdo SHA-256 idêntico a um ficheiro gerido existente que o utilizador pode ver é reutilizado em vez de guardado de novo. Quando o media módulo está instalado e um tipo de média chamado image, media_image, video ou media_video existe, uma entidade de média publicada é criada (ou reutilizada) para o ficheiro. O módulo dxpr_builder regista o uso do ficheiro.

Respostas:

Caixa de diálogo da biblioteca de média

O tipo de média oferecido depende do media_browser definição: media_library usa o image ou video tipo de média diretamente; media_library_acquia_dam usa acquia_dam_image_asset ou acquia_dam_video_asset quando esse tipo de média existe.

Respostas:

Validador de ligações de ajuda

Resposta: um array JSON. [true] quando um pedido HEAD à ligação (sem seguir redirecionamentos) devolve 200; [false] quando o cliente HTTP dispara; [] em todos os outros casos, incluindo um parâmetro em falta, um URL não correspondente ou um estado diferente de 200.

Sugestões de ligações de entidades

Os pacotes são os com ckeditor5_link_suggestions ativado na sua informação de pacote; quando nenhum está configurado, pesquisam-se todos os pacotes de nós. Até 100 entidades por tipo de entidade são associadas com um CONTAINS pesquisa através dos plugins de seleção de referências de entidades do núcleo.

Resposta: {"suggestions": [...]} com possibilidade de cache privada e idade máxima de 300 segundos. Cada sugestão tem description, entity_type_id, entity_uuid, group, label e path. Quando q não corresponde a nada, o array contém uma única sugestão de ligação manual com description, label (a entrada em minúsculas) e path (a entrada quando é um URL válido, senão uma string vazia). Quando q está vazio, suggestions é um array vazio.

Definições de editor do utilizador

O editor envia este pedido quando um utilizador muda as suas próprias definições de editor, por exemplo em Definições do editor. Os valores são guardados com a conta de utilizador em user.data, módulo dxpr_builder.

Respostas:

Operações do processador AJAX principal

Todas as operações vão para /dxpr_builder/ajax com o parâmetro de consulta de token obtido de /dxpr_builder/csrf. O nome da operação é enviado no campo do corpo POST action; todos os outros parâmetros são campos do corpo POST salvo indicação em contrário. A coluna "Re-checks billable" marca as operações que chamam isBillableUser() novamente dentro do switch. Quando essa verificação falha, devolvem a vazia AjaxResponse descrito acima, salvo se a linha disser o contrário.

Sessão e acesso

Contentores (campos apresentados com o formatador DXPR Builder)

dxpr_save_container faz o seguinte:

1. Descodifica htmlContent: XOR a cada byte com 7 e depois descodificação de URL.
2. Escreve o resultado no primeiro delta do campo indicado.
3. Cria uma nova revisão predefinida com a mensagem de registo Saved with DXPR builder quando o tipo de entidade permite revisões.
4. Remove qualquer bloqueio de conteúdo da entidade.
5. Atualizações block_revision_id em secções Layout Builder que referenciam o bloco em linha guardado.
6. Incrementa o dxpr_builder.saves_count valor de estado.

A gravação só acontece quando o utilizador tem update acesso à entidade. Sem ele, a operação continua a devolver a resposta de sucesso de string vazia.

Elementos CMS (blocos e vistas)

Em ambos settingsoperações que devolvem, css e js são etiquetas de recursos apresentadas ainda não presentes na página, e settings é o descodificado drupalSettings objeto, ou uma string vazia quando não há nenhum.

Modelos de página

Modelos de utilizador

O nome de máquina deriva de name passando-o para minúsculas e substituindo cada sequência de carateres fora de a-z0-9_ por um sublinhado. type recorre ao data-azb atributo na marcação quando um modelo guardado não tem tipo.

Imagens

Bloqueios de conteúdo

Páginas de administração

Todas estas rotas aceitam qualquer método (sem methods chave). Caminhos que contêm {...} levam o ID da entidade de configuração, ou o ID de migração para {migration_id}.

E a seguir?

• Referência de configuração para as definições que controlam o navegador de média e o comportamento de IA usados por estes pontos de extremidade.
• API PHP para os serviços que os controladores chamam.
• API de hooks para os hooks que permitem a outros módulos alterar o comportamento do construtor.