Eigener Client

​

WebSocket API (STOMP)

• Native WebSocket-Endpoint: /ws
• SockJS-Fallback-Endpoint: /sock
• Application Destination Prefix: /request
• Broker Destinations: /topic/**, /user/topic/** und /queue/**

​

Subscribe

• /topic/msm/json
• /user/topic/msm/json

• /topic/msm/render
• /user/topic/msm/render

​

Publish-Destinations

​

Request- und Response-Format

• path: aktueller Page-Pfad (Request-Kontext)
• payload: optionale Daten (abhängig von der Destination)
• elements: optionale Liste von Element-Payloads für Partial Updates
• actionId: optionale Correlation-Id (empfohlen)
• eventType: USER, SHARED oder GLOBAL
• sharedEndpoint: optionaler logischer Endpoint-Name (Antwort kommt an /topic/<sharedEndpoint>)

• BeanRequestMessage: scope, beanId, functionName, args
• RepositoryRequestMessage: repositoryId, requestType
• DocumentRequestMessage: databaseName, collectionName, requestType

{
  "result": {},
  "actionId": "a1b2c3d4e5f6"
}

​

Beispiel (Browser)

import { Client } from "@stomp/stompjs";
import SockJS from "sockjs-client";

const client = new Client({
  // brokerURL: "wss://example.com/ws",
  webSocketFactory: () => new SockJS("/sock"),
  reconnectDelay: 2000,
});

client.onConnect = () => {
  client.subscribe("/user/topic/msm/json", (msg) => {
    console.log("JSON response", JSON.parse(msg.body));
  });

  const actionId = Math.random().toString(16).slice(2, 14);

  client.publish({
    destination: "/request/json/bean/INVOKE",
    headers: {
      // Optional: JWT als native STOMP-Header
      // Authorization: "Bearer <token>",
    },
    body: JSON.stringify({
      path: "/current/page",
      scope: "PROTOTYPE",
      beanId: "someServiceImpl",
      functionName: "someMethod",
      args: [{ 0: { query: {}, language: "en" } }],
      actionId,
      eventType: "USER",
    }),
  });
};

client.activate();

​

Hinweise zur Autorisierung

• JSON-Handler akzeptieren optional ein JWT über den nativen Header Authorization: Bearer <token>.
• Einige Operationen erfordern höhere Berechtigungen (z. B. Repository-Updates und Datenbank-Schreiboperationen). Bei fehlendem Zugriff antwortet das Backend mit { "error": "Access denied", ... }.

​

REST API

• Authentifizierung (/api/v1/authenticate, /api/v1/logout, Token-Operationen)
• Datei- und Daten-Operationen (upload/remove/download)
• Report-Export und Asset-Listing
• Integrationen (z. B. Delivery/Payment Provider)
• HTTP-Fallback für Service-Calls (/api/v1/bean/request)

​

Häufige Header

​

Authentifizierung

​

Unified Service Call über HTTP

• Site-Context
• Lang-Context

{
  "beanId": "someServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "someMethod",
  "args": [
    {
      "0": {
        "query": {},
        "language": "en"
      }
    }
  ]
}

{
  "result": {}
}

​

Uploads, Downloads, Assets, Reports

const formData = new FormData();
formData.append("file", file);
formData.append("payload", JSON.stringify({ destination: "/local/images" }));
formData.append("command", "UPLOAD_IMAGE");

const res = await fetch("/api/v1/uploadImage", { method: "POST", body: formData });
const json = await res.json(); // z. B. { url: "...", name: "..." }

const formData = new FormData();
formData.append("payload", JSON.stringify({ fileName: "report.csv", searchRequest: {/* ... */} }));
formData.append("command", "EXPORT_SEARCH_DATA_DUMP");

const res = await fetch("/api/v1/downloadReportsData", { method: "POST", body: formData });
const blob = await res.blob();

​

Delivery- und Payment-Integrationen

• /api/v1/cdek (Delivery Widget Service/Proxy)
• /api/v1/stripe (Stripe-Zahlungs-Webhook)
• /api/v1/yookassa (Payment Integration)

​

Passwort-Reset und Verifikation

• /api/v1/auth/verify
• /api/v1/auth/reset-password
• /api/v1/auth/change-password
• /api/v1/auth/save-password