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, carga de medios y operaciones de esquema.

Autenticación

Las solicitudes de la API requieren autenticación mediante un token Bearer en el encabezado Authorization:

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. Una respuesta exitosa envuelve el resultado en data:

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

Una respuesta de error incluye un código, mensaje y detalles opcionales:

{
  "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 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 del archivo real. 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 campos (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

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

Eliminar Colección

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

Parámetros

ParámetroTipoDescripción
forcebooleanEliminar incluso si la colección tiene 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

PUT /_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/admin/plugins

Obtener Plugin

GET /_emdash/api/admin/plugins/:id

Habilitar Plugin

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

Deshabilitar Plugin

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

Códigos de Error

CódigoEstado HTTPDescripción
NOT_FOUND404Recurso no encontrado
VALIDATION_ERROR400Datos de entrada inválidos
UNAUTHORIZED401Token faltante 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_CREATE_ERROR500Operación de esquema falló
SLUG_CONFLICT409El 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 (requerido)
collectionsstringSlugs de colecciones separados por comas
statusstringFiltrar por estado (predeterminado: published)
limitnumberResultados máximos (predeterminado: 20)
cursorstringCursor de paginación

Respuesta

{
  "success": true,
  "data": {
    "items": [
      {
        "collection": "posts",
        "id": "01HXK5MZSN...",
        "slug": "hello-world",
        "locale": "en",
        "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 que coinciden con el 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 conteos 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 Configuración

Obtener Todas las Configuraciones

GET /_emdash/api/settings

Actualizar Configuraciones

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

Agregar 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

Establecer Términos de 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 Widget

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

Crear Área de Widget

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

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

Eliminar Área de Widget

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

Agregar 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

PUT /_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

Obtiene opciones de autenticación WebAuthn.

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

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

Verifica el passkey y crea la sesión.

Enlace Mágico

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

{
  "email": "user@example.com"
}
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": "newuser@example.com",
  "role": 30
}

Gestión de Passkeys

GET /_emdash/api/auth/passkey

Lista los passkeys del usuario.

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

Registra un nuevo passkey.

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

{
  "name": "MacBook Pro"
}

Renombra el passkey.

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

Elimina el passkey.

Endpoints de Importación

Analizar Exportación de WordPress

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

file: <WXR file>

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 la tasa, las respuestas incluyen:

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

CORS

La API admite CORS para solicitudes de navegadores. Configura los orígenes permitidos en tu despliegue.