E EmDash CMS Everything Guides, use cases, plugins, templates
Español

Referencia de la API REST

En esta página

EmDash expone una API REST en /_emdash/api/ para gestión de contenido, subida de medios y operaciones de esquema.

Autenticación

Las solicitudes a la API requieren autenticación mediante Bearer token:

Authorization: Bearer <token>

Genera tokens a través de la interfaz de administración o programáticamente.

Formato de respuesta

Todas las respuestas siguen un formato consistente:

// Éxito
{
  "success": true,
  "data": { ... }
}

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

Endpoints de contenido

Listar contenido

GET /_emdash/api/content/:collection

Parámetros

ParámetroTipoDescripción
collectionstringSlug de la colección (ruta)
cursorstringCursor de paginación (query)
limitnumberElementos por página (query, predeterminado: 50)
statusstringFiltrar por estado (query)
orderBystringCampo para ordenar (query)
orderstringDirección de orden: asc o desc (query)

Respuesta

{
  "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..."
  }
}

Obtener contenido

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

Respuesta

{
  "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"
    }
  }
}

Crear contenido

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

Cuerpo de la solicitud

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

Respuesta

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

Actualizar contenido

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

Cuerpo de la solicitud

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

Eliminar contenido

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

Respuesta

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

Endpoints de medios

Listar medios

GET /_emdash/api/media

Parámetros

ParámetroTipoDescripción
cursorstringCursor de paginación
limitnumberElementos por página (predeterminado: 20)
mimeTypestringFiltrar por prefijo de tipo MIME

Respuesta

{
	"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..."
	}
}

Obtener medio

GET /_emdash/api/media/:id

Crear medio

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

Cuerpo de la solicitud

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

Actualizar medio

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

Cuerpo de la solicitud

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

Eliminar medio

DELETE /_emdash/api/media/:id

Obtener archivo de medio

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

Sirve el contenido real del archivo. Solo para almacenamiento local.

Endpoints de revisiones

Listar revisiones

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

Parámetros

ParámetroTipoDescripción
limitnumberMáximo de revisiones a devolver (predeterminado: 50)

Respuesta

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

Obtener revisión

GET /_emdash/api/revisions/:revisionId

Restaurar revisión

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

Restaura el contenido al estado de esta revisión y crea una nueva revisión.

Endpoints de esquema

Listar colecciones

GET /_emdash/api/schema/collections

Respuesta

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

Obtener colección

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

Parámetros

ParámetroTipoDescripción
includeFieldsbooleanIncluir definiciones de campo (query)

Crear colección

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

Cuerpo de la solicitud

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

Actualizar colección

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

Eliminar colección

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

Parámetros

ParámetroTipoDescripción
forcebooleanEliminar aunque la colección tenga contenido (query)

Listar campos

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

Crear campo

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

Cuerpo de la solicitud

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

Actualizar campo

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

Eliminar campo

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

Reordenar campos

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

Cuerpo de la solicitud

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

Exportación de esquema

Exportar esquema (JSON)

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

Exportar esquema (TypeScript)

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

Devuelve interfaces TypeScript para todas las colecciones.

Endpoints de plugins

Listar plugins

GET /_emdash/api/plugins

Obtener plugin

GET /_emdash/api/plugins/:pluginId

Habilitar plugin

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

Deshabilitar plugin

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

Códigos de error

CódigoEstado HTTPDescripción
NOT_FOUND404Recurso no encontrado
VALIDATION_ERROR400Datos de entrada inválidos
UNAUTHORIZED401Token ausente o inválido
FORBIDDEN403Permisos insuficientes
CONTENT_LIST_ERROR500Error al listar contenido
CONTENT_CREATE_ERROR500Error al crear contenido
CONTENT_UPDATE_ERROR500Error al actualizar contenido
CONTENT_DELETE_ERROR500Error al eliminar contenido
MEDIA_LIST_ERROR500Error al listar medios
MEDIA_CREATE_ERROR500Error al crear medio
SCHEMA_ERROR400Operación de esquema fallida
DUPLICATE_SLUG409El slug ya existe
RESERVED_SLUG400El slug está reservado

Endpoints de búsqueda

Búsqueda global

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

Parámetros

ParámetroTipoDescripción
qstringConsulta de búsqueda (obligatorio)
collectionsstringSlugs de colección separados por comas
statusstringFiltrar por estado (predeterminado: published)
limitnumberMáximo de resultados (predeterminado: 20)
cursorstringCursor de paginación

Respuesta

{
  "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"
}

Sugerencias de búsqueda

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

Devuelve títulos con coincidencia de prefijo para autocompletado.

Reconstruir índice de búsqueda

POST /_emdash/api/search/rebuild

Reconstruye el índice FTS para todas o colecciones específicas.

Estadísticas de búsqueda

GET /_emdash/api/search/stats

Devuelve el conteo de documentos indexados por colección.

Endpoints de secciones

Listar secciones

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

Obtener sección

GET /_emdash/api/sections/:slug

Crear sección

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

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

Actualizar sección

PUT /_emdash/api/sections/:slug

Eliminar sección

DELETE /_emdash/api/sections/:slug

Endpoints de ajustes

Obtener todos los ajustes

GET /_emdash/api/settings

Actualizar ajustes

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

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

Endpoints de menús

Listar menús

GET /_emdash/api/menus

Obtener menú

GET /_emdash/api/menus/:name

Crear menú

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

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

Actualizar menú

PUT /_emdash/api/menus/:name

Eliminar menú

DELETE /_emdash/api/menus/:name

Añadir elemento de menú

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

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

Reordenar elementos de menú

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 }
  ]
}

Endpoints de taxonomías

Listar definiciones de taxonomías

GET /_emdash/api/taxonomies

Crear taxonomía

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

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

Listar términos

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

Crear término

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

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

Actualizar término

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

Eliminar término

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

Asignar términos a entrada

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

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

Endpoints de áreas de widgets

Listar áreas de widgets

GET /_emdash/api/widget-areas

Obtener área de widgets

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

Crear área de widgets

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

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

Eliminar área de widgets

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

Añadir widget

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

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

Actualizar widget

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

Eliminar widget

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

Reordenar widgets

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

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

Endpoints de gestión de usuarios

Listar usuarios

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

Obtener usuario

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

Actualizar usuario

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

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

Habilitar usuario

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

Deshabilitar usuario

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

Endpoints de autenticación

Estado de configuración

GET /_emdash/api/setup/status

Devuelve si la configuración está completa y si existen usuarios.

Inicio de sesión con passkey

POST /_emdash/api/auth/passkey/options

Obtener opciones de autenticación WebAuthn.

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

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

Verificar passkey y crear sesión.

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

{
  "email": "[email protected]"
}
GET /_emdash/api/auth/magic-link/verify?token=xxx

Cerrar sesión

POST /_emdash/api/auth/logout

Usuario actual

GET /_emdash/api/auth/me

Invitar usuario

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

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

Gestión de passkeys

GET /_emdash/api/auth/passkey

Listar las passkeys del usuario.

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

Registrar nueva passkey.

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

{
  "name": "MacBook Pro"
}

Renombrar passkey.

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

Eliminar passkey.

Endpoints de importación

Analizar exportación de WordPress

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

file: <archivo WXR>

Ejecutar importación de WordPress

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

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

Limitación de tasa

Los endpoints de la API pueden tener limitación de tasa según la configuración del despliegue. Cuando se limita, las respuestas incluyen:

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

CORS

La API soporta CORS para solicitudes del navegador. Configura los orígenes permitidos en tu despliegue.