REST-API-Referenz | EmDash CMS Everything

EmDash stellt eine REST-API unter /_emdash/api/ für Inhaltsverwaltung, Medien-Uploads und Schema-Operationen bereit.

Authentifizierung

API-Anfragen erfordern eine Authentifizierung über ein Bearer-Token:

Authorization: Bearer <token>

Erstellen Sie Tokens über die Admin-Oberfläche oder programmatisch.

Antwortformat

Alle Antworten folgen einem einheitlichen Format:

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message",
    "details": { ... }
  }
}

Inhalts-Endpunkte

Inhalte auflisten

GET /_emdash/api/content/:collection

Parameter

Parameter	Typ	Beschreibung
`collection`	`string`	Collection-Slug (Pfad)
`cursor`	`string`	Paginierungs-Cursor (Query)
`limit`	`number`	Einträge pro Seite (Query, Standard: 50)
`status`	`string`	Nach Status filtern (Query)
`orderBy`	`string`	Feld zum Sortieren (Query)
`order`	`string`	Sortierrichtung: `asc` oder `desc` (Query)

Antwort

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "01HXK5MZSN...",
        "type": "posts",
        "slug": "hello-world",
        "data": { "title": "Hello World", ... },
        "status": "published",
        "createdAt": "2025-01-24T12:00:00Z",
        "updatedAt": "2025-01-24T12:00:00Z"
      }
    ],
    "nextCursor": "eyJpZCI6..."
  }
}

Inhalt abrufen

GET /_emdash/api/content/:collection/:id

Antwort

{
  "success": true,
  "data": {
    "item": {
      "id": "01HXK5MZSN...",
      "type": "posts",
      "slug": "hello-world",
      "data": { "title": "Hello World", ... },
      "status": "published",
      "createdAt": "2025-01-24T12:00:00Z",
      "updatedAt": "2025-01-24T12:00:00Z"
    }
  }
}

Inhalt erstellen

POST /_emdash/api/content/:collection
Content-Type: application/json

Anfragekörper

{
  "data": {
    "title": "New Post",
    "content": [...]
  },
  "slug": "new-post",
  "status": "draft"
}

Antwort

{
  "success": true,
  "data": {
    "item": { ... }
  }
}

Inhalt aktualisieren

PUT /_emdash/api/content/:collection/:id
Content-Type: application/json

Anfragekörper

{
	"data": {
		"title": "Updated Title"
	},
	"status": "published"
}

Inhalt löschen

DELETE /_emdash/api/content/:collection/:id

Antwort

{
	"success": true,
	"data": {
		"success": true
	}
}

Medien-Endpunkte

Medien auflisten

GET /_emdash/api/media

Parameter

Parameter	Typ	Beschreibung
`cursor`	`string`	Paginierungs-Cursor
`limit`	`number`	Einträge pro Seite (Standard: 20)
`mimeType`	`string`	Nach MIME-Typ-Präfix filtern

Antwort

{
	"success": true,
	"data": {
		"items": [
			{
				"id": "01HXK5MZSN...",
				"filename": "photo.jpg",
				"mimeType": "image/jpeg",
				"size": 102400,
				"width": 1920,
				"height": 1080,
				"url": "https://cdn.example.com/photo.jpg",
				"createdAt": "2025-01-24T12:00:00Z"
			}
		],
		"nextCursor": "eyJpZCI6..."
	}
}

Medium abrufen

GET /_emdash/api/media/:id

Medium erstellen

POST /_emdash/api/media
Content-Type: application/json

Anfragekörper

{
	"filename": "photo.jpg",
	"mimeType": "image/jpeg",
	"size": 102400,
	"width": 1920,
	"height": 1080,
	"storageKey": "uploads/photo.jpg"
}

Medium aktualisieren

PUT /_emdash/api/media/:id
Content-Type: application/json

Anfragekörper

{
	"alt": "Photo description",
	"caption": "Photo caption"
}

Medium löschen

DELETE /_emdash/api/media/:id

Mediendatei abrufen

GET /_emdash/api/media/file/:key

Liefert den eigentlichen Dateiinhalt aus. Nur für lokalen Speicher.

Revisions-Endpunkte

Revisionen auflisten

GET /_emdash/api/content/:collection/:entryId/revisions

Parameter

Parameter	Typ	Beschreibung
`limit`	`number`	Maximale Anzahl zurückgegebener Revisionen (Standard: 50)

Antwort

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "01HXK5MZSN...",
        "collection": "posts",
        "entryId": "01HXK5MZSN...",
        "data": { ... },
        "createdAt": "2025-01-24T12:00:00Z"
      }
    ],
    "total": 5
  }
}

Revision abrufen

GET /_emdash/api/revisions/:revisionId

Revision wiederherstellen

POST /_emdash/api/revisions/:revisionId/restore

Stellt den Inhalt auf den Zustand dieser Revision wieder her und erstellt eine neue Revision.

Schema-Endpunkte

Collections auflisten

GET /_emdash/api/schema/collections

Antwort

{
	"success": true,
	"data": {
		"items": [
			{
				"id": "01HXK5MZSN...",
				"slug": "posts",
				"label": "Posts",
				"labelSingular": "Post",
				"supports": ["drafts", "revisions", "preview"]
			}
		]
	}
}

Collection abrufen

GET /_emdash/api/schema/collections/:slug

Parameter

Parameter	Typ	Beschreibung
`includeFields`	`boolean`	Felddefinitionen einbeziehen (Query)

Collection erstellen

POST /_emdash/api/schema/collections
Content-Type: application/json

Anfragekörper

{
	"slug": "products",
	"label": "Products",
	"labelSingular": "Product",
	"description": "Product catalog",
	"supports": ["drafts", "revisions"]
}

Collection aktualisieren

PATCH /_emdash/api/schema/collections/:slug
Content-Type: application/json

Collection löschen

DELETE /_emdash/api/schema/collections/:slug

Parameter

Parameter	Typ	Beschreibung
`force`	`boolean`	Auch löschen, wenn die Collection Inhalte enthält (Query)

Felder auflisten

GET /_emdash/api/schema/collections/:slug/fields

Feld erstellen

POST /_emdash/api/schema/collections/:slug/fields
Content-Type: application/json

Anfragekörper

{
	"slug": "price",
	"label": "Price",
	"type": "number",
	"required": true,
	"validation": {
		"min": 0
	}
}

Feld aktualisieren

PATCH /_emdash/api/schema/collections/:collectionSlug/fields/:fieldSlug
Content-Type: application/json

Feld löschen

DELETE /_emdash/api/schema/collections/:collectionSlug/fields/:fieldSlug

Felder neu ordnen

POST /_emdash/api/schema/collections/:slug/fields/reorder
Content-Type: application/json

Anfragekörper

{
	"fieldSlugs": ["title", "content", "author", "publishedAt"]
}

Schema-Export

Schema exportieren (JSON)

GET /_emdash/api/schema
Accept: application/json

Schema exportieren (TypeScript)

GET /_emdash/api/schema?format=typescript
Accept: text/typescript

Gibt TypeScript-Interfaces für alle Collections zurück.

Plugin-Endpunkte

Plugins auflisten

GET /_emdash/api/plugins

Plugin abrufen

GET /_emdash/api/plugins/:pluginId

Plugin aktivieren

POST /_emdash/api/plugins/:pluginId/enable

Plugin deaktivieren

POST /_emdash/api/plugins/:pluginId/disable

Fehlercodes

Code	HTTP-Status	Beschreibung
`NOT_FOUND`	404	Ressource nicht gefunden
`VALIDATION_ERROR`	400	Ungültige Eingabedaten
`UNAUTHORIZED`	401	Fehlendes oder ungültiges Token
`FORBIDDEN`	403	Unzureichende Berechtigungen
`CONTENT_LIST_ERROR`	500	Inhalte konnten nicht aufgelistet werden
`CONTENT_CREATE_ERROR`	500	Inhalt konnte nicht erstellt werden
`CONTENT_UPDATE_ERROR`	500	Inhalt konnte nicht aktualisiert werden
`CONTENT_DELETE_ERROR`	500	Inhalt konnte nicht gelöscht werden
`MEDIA_LIST_ERROR`	500	Medien konnten nicht aufgelistet werden
`MEDIA_CREATE_ERROR`	500	Medium konnte nicht erstellt werden
`SCHEMA_ERROR`	400	Schema-Operation fehlgeschlagen
`DUPLICATE_SLUG`	409	Slug existiert bereits
`RESERVED_SLUG`	400	Slug ist reserviert

Such-Endpunkte

Globale Suche

GET /_emdash/api/search?q=hello+world

Parameter

Parameter	Typ	Beschreibung
`q`	`string`	Suchanfrage (erforderlich)
`collections`	`string`	Kommagetrennte Collection-Slugs
`status`	`string`	Nach Status filtern (Standard: published)
`limit`	`number`	Maximale Ergebnisse (Standard: 20)
`cursor`	`string`	Paginierungs-Cursor

Antwort

{
  "results": [
    {
      "collection": "posts",
      "id": "01HXK5MZSN...",
      "slug": "hello-world",
      "title": "Hello World",
      "snippet": "...this is a <mark>hello</mark> <mark>world</mark> example...",
      "score": 0.95
    }
  ],
  "nextCursor": "eyJvZmZzZXQiOjIwfQ"
}

Suchvorschläge

GET /_emdash/api/search/suggest?q=hel&limit=5

Gibt präfixbasierte Titelvorschläge für die Autovervollständigung zurück.

Suchindex neu aufbauen

POST /_emdash/api/search/rebuild

Baut den FTS-Index für alle oder bestimmte Collections neu auf.

Suchstatistiken

GET /_emdash/api/search/stats

Gibt die Anzahl indexierter Dokumente pro Collection zurück.

Abschnitts-Endpunkte

Abschnitte auflisten

GET /_emdash/api/sections
GET /_emdash/api/sections?source=theme
GET /_emdash/api/sections?search=newsletter

Abschnitt abrufen

GET /_emdash/api/sections/:slug

Abschnitt erstellen

POST /_emdash/api/sections
Content-Type: application/json

{
  "slug": "my-section",
  "title": "My Section",
  "keywords": ["keyword1"],
  "content": [...]
}

Abschnitt aktualisieren

PUT /_emdash/api/sections/:slug

Abschnitt löschen

DELETE /_emdash/api/sections/:slug

Einstellungs-Endpunkte

Alle Einstellungen abrufen

GET /_emdash/api/settings

Einstellungen aktualisieren

POST /_emdash/api/settings
Content-Type: application/json

{
  "siteTitle": "My Site",
  "tagline": "A great site",
  "postsPerPage": 10
}

Menü-Endpunkte

Menüs auflisten

GET /_emdash/api/menus

Menü abrufen

GET /_emdash/api/menus/:name

Menü erstellen

POST /_emdash/api/menus
Content-Type: application/json

{
  "name": "footer",
  "label": "Footer Navigation"
}

Menü aktualisieren

PUT /_emdash/api/menus/:name

Menü löschen

DELETE /_emdash/api/menus/:name

Menüeintrag hinzufügen

POST /_emdash/api/menus/:name/items
Content-Type: application/json

{
  "type": "page",
  "referenceCollection": "pages",
  "referenceId": "page_about",
  "label": "About Us"
}

Menüeinträge neu ordnen

POST /_emdash/api/menus/:name/reorder
Content-Type: application/json

{
  "items": [
    { "id": "item_1", "parentId": null, "sortOrder": 0 },
    { "id": "item_2", "parentId": null, "sortOrder": 1 },
    { "id": "item_3", "parentId": "item_2", "sortOrder": 0 }
  ]
}

Taxonomie-Endpunkte

Taxonomie-Definitionen auflisten

GET /_emdash/api/taxonomies

Taxonomie erstellen

POST /_emdash/api/taxonomies
Content-Type: application/json

{
  "name": "genre",
  "label": "Genres",
  "labelSingular": "Genre",
  "hierarchical": true,
  "collections": ["books", "movies"]
}

Begriffe auflisten

GET /_emdash/api/taxonomies/:name/terms

Begriff erstellen

POST /_emdash/api/taxonomies/:name/terms
Content-Type: application/json

{
  "slug": "tutorials",
  "label": "Tutorials",
  "parentId": "term_abc",
  "description": "How-to guides"
}

Begriff aktualisieren

PUT /_emdash/api/taxonomies/:name/terms/:slug

Begriff löschen

DELETE /_emdash/api/taxonomies/:name/terms/:slug

Eintrags-Begriffe setzen

POST /_emdash/api/content/:collection/:id/terms/:taxonomy
Content-Type: application/json

{
  "termIds": ["term_news", "term_featured"]
}

GET /_emdash/api/widget-areas

GET /_emdash/api/widget-areas/:name

POST /_emdash/api/widget-areas
Content-Type: application/json

{
  "name": "sidebar",
  "label": "Main Sidebar",
  "description": "Appears on posts"
}

DELETE /_emdash/api/widget-areas/:name

POST /_emdash/api/widget-areas/:name/widgets
Content-Type: application/json

{
  "type": "content",
  "title": "About",
  "content": [...]
}

PUT /_emdash/api/widget-areas/:name/widgets/:id

DELETE /_emdash/api/widget-areas/:name/widgets/:id

Widgets neu ordnen

POST /_emdash/api/widget-areas/:name/reorder
Content-Type: application/json

{
  "widgetIds": ["widget_1", "widget_2", "widget_3"]
}

Benutzerverwaltungs-Endpunkte

Benutzer auflisten

GET /_emdash/api/admin/users
GET /_emdash/api/admin/users?role=40
GET /_emdash/api/admin/users?search=john

Benutzer abrufen

GET /_emdash/api/admin/users/:id

Benutzer aktualisieren

PATCH /_emdash/api/admin/users/:id
Content-Type: application/json

{
  "name": "John Doe",
  "role": 40
}

Benutzer aktivieren

POST /_emdash/api/admin/users/:id/enable

Benutzer deaktivieren

POST /_emdash/api/admin/users/:id/disable

Authentifizierungs-Endpunkte

Einrichtungsstatus

GET /_emdash/api/setup/status

Gibt zurück, ob die Einrichtung abgeschlossen ist und ob Benutzer existieren.

Passkey-Anmeldung

POST /_emdash/api/auth/passkey/options

WebAuthn-Authentifizierungsoptionen abrufen.

POST /_emdash/api/auth/passkey/verify
Content-Type: application/json

{
  "id": "credential-id",
  "rawId": "...",
  "response": {...},
  "type": "public-key"
}

Passkey verifizieren und Sitzung erstellen.

Magic Link

POST /_emdash/api/auth/magic-link/send
Content-Type: application/json

{
  "email": "[email protected]"
}

GET /_emdash/api/auth/magic-link/verify?token=xxx

Abmelden

POST /_emdash/api/auth/logout

Aktueller Benutzer

GET /_emdash/api/auth/me

Benutzer einladen

POST /_emdash/api/auth/invite
Content-Type: application/json

{
  "email": "[email protected]",
  "role": 30
}

Passkey-Verwaltung

GET /_emdash/api/auth/passkey

Passkeys des Benutzers auflisten.

POST /_emdash/api/auth/passkey/register/options
POST /_emdash/api/auth/passkey/register/verify

Neuen Passkey registrieren.

PATCH /_emdash/api/auth/passkey/:id
Content-Type: application/json

{
  "name": "MacBook Pro"
}

Passkey umbenennen.

DELETE /_emdash/api/auth/passkey/:id

Passkey löschen.

Import-Endpunkte

WordPress-Export analysieren

POST /_emdash/api/import/wordpress/analyze
Content-Type: multipart/form-data

file: <WXR file>

WordPress-Import ausführen

POST /_emdash/api/import/wordpress/execute
Content-Type: application/json

{
  "analysisId": "...",
  "options": {
    "includeMedia": true,
    "includeTaxonomies": true,
    "includeMenus": true
  }
}

Ratenbegrenzung

API-Endpunkte können je nach Deployment-Konfiguration ratenbegrenzt sein. Bei Ratenbegrenzung enthalten die Antworten:

HTTP/1.1 429 Too Many Requests
Retry-After: 60

CORS

Die API unterstützt CORS für Browser-Anfragen. Konfigurieren Sie die erlaubten Origins in Ihrem Deployment.