REST-API im Überblick

Die REST-API liest und ändert die Inhalte einer Marke als JSON. Brandhub bestimmt die Marke aus dem Key, einen Marken-Parameter gibt es nicht. Alle Endpunkte mit Parametern, Feldern und Antworten finden Sie in der Referenz.

Basis-URL

Alle Pfade hängen an dieser URL. Ersetzen Sie <marke> durch die Subdomain Ihres Portals.

https://<marke>.brandhub.31m.de/api/v1

Header

Senden Sie bei jedem Aufruf diese Header:

Authorization: Bearer IHR_API_KEY
Accept: application/json

Aufrufe mit Body brauchen zusätzlich:

Content-Type: application/json

Lesende Endpunkte brauchen das Recht read, schreibende write. Wie Sie einen Key erhalten, steht unter Authentifizierung.

Antworten

Listen kommen als JSON-Array auf oberster Ebene, ohne data-Hülle.

[ { "id": 1, "name": "Primär", "role": "primary", "description": "Für Flächen und Buttons." } ]

Schreibende Aufrufe ändern das Portal sofort. Brandhub versioniert jede Änderung, im Backend lässt sie sich nachvollziehen und zurücksetzen. Aufrufe auf Seiten und Blöcke antworten mit der vollständigen Seite, neue Block-IDs können Sie also direkt weiterverwenden.

Module

Zwei Bereiche hängen an Modulen Ihrer Marke. Ohne das Modul antwortet die API dort mit 404.

Bereich	Modul
Corporate Language (/brand/cl)	Corporate Language
Markenkontext (/brand/context)	Markenagent (KI)

Blöcke schreiben

Ein Block ist ein Objekt { "type": "…", "data": { … } }. Brandhub prüft ihn wie der Editor im Backend. Unbekannte Typen lehnt die API mit 422 ab, unbekannte Felder verwirft sie, HTML bereinigt sie.

Schreibbare Typen sind heading, rich_text, alert, button, video, image_placeholder, accordion, table, columns, group, image, gallery, tabs, asset_download, download_list und color_palette. Medien- und Asset-Blöcke verweisen auf IDs aus GET /media, fremde oder erfundene IDs lehnt die API ab.

curl -X POST \
  -H "Authorization: Bearer IHR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{ "type": "alert", "data": { "variant": "warning", "title": "Achtung", "body": "Logo nie verzerren." } }' \
  https://<marke>.brandhub.31m.de/api/v1/pages/12/blocks

Ändern Sie einzelne Blöcke über ihre ID. PUT /pages/{page}/content ersetzt den ganzen Inhalt und ist für Fälle gedacht, in denen das nicht reicht.

OpenAPI

Die Referenz entsteht aus einer OpenAPI-3.1-Spezifikation. Mit ihr erzeugen Sie Clients oder importieren die API in Werkzeuge wie Postman oder n8n: openapi.json herunterladen.