E EmDash CMS Everything Guides, use cases, plugins, templates
Français

Référence de l'API REST

Sur cette page

EmDash expose une API REST à /_emdash/api/ pour la gestion du contenu, le téléchargement de médias et les opérations de schéma.

Authentification

Les requêtes API nécessitent une authentification via un jeton Bearer dans l’en-tête Authorization :

Authorization: Bearer <token>

Générez des jetons via l’interface d’administration ou par programmation.

Format de réponse

Toutes les réponses suivent un format cohérent. Une réponse réussie encapsule le résultat dans data :

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

Une réponse d’erreur inclut un code, un message et des détails optionnels :

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

Points de Terminaison de Contenu

Lister le Contenu

GET /_emdash/api/content/:collection

Paramètres

ParamètreTypeDescription
collectionstringSlug de collection (chemin)
cursorstringCurseur de pagination (query)
limitnumberÉléments par page (query, défaut : 50)
statusstringFiltrer par statut (query)
orderBystringChamp de tri (query)
orderstringDirection de tri : asc ou desc (query)

Réponse

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

Obtenir le Contenu

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

Réponse

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

Créer du Contenu

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

Corps de la Requête

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

Réponse

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

Mettre à Jour le Contenu

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

Corps de la Requête

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

Supprimer du Contenu

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

Réponse

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

Points de Terminaison des Médias

Lister les Médias

GET /_emdash/api/media

Paramètres

ParamètreTypeDescription
cursorstringCurseur de pagination
limitnumberÉléments par page (défaut : 20)
mimeTypestringFiltrer par préfixe de type MIME

Réponse

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

Obtenir un Média

GET /_emdash/api/media/:id

Créer un Média

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

Corps de la Requête

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

Mettre à Jour un Média

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

Corps de la Requête

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

Supprimer un Média

DELETE /_emdash/api/media/:id

Obtenir le Fichier Média

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

Sert le contenu réel du fichier. Pour le stockage local uniquement.

Points de Terminaison des Révisions

Lister les Révisions

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

Paramètres

ParamètreTypeDescription
limitnumberMaximum de révisions à retourner (défaut : 50)

Réponse

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

Obtenir une Révision

GET /_emdash/api/revisions/:revisionId

Restaurer une Révision

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

Restaure le contenu à l’état de cette révision et crée une nouvelle révision.

Points de Terminaison de Schéma

Lister les Collections

GET /_emdash/api/schema/collections

Réponse

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

Obtenir une Collection

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

Paramètres

ParamètreTypeDescription
includeFieldsbooleanInclure les définitions de champs (query)

Créer une Collection

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

Corps de la Requête

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

Mettre à Jour une Collection

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

Supprimer une Collection

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

Paramètres

ParamètreTypDescription
forcebooleanSupprimer même si la collection contient du contenu (query)

Lister les Champs

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

Créer un Champ

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

Corps de la Requête

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

Mettre à Jour un Champ

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

Supprimer un Champ

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

Réorganiser les Champs

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

Corps de la Requête

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

Export de Schéma

Exporter le Schéma (JSON)

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

Exporter le Schéma (TypeScript)

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

Retourne les interfaces TypeScript pour toutes les collections.

Points de Terminaison des Plugins

Lister les Plugins

GET /_emdash/api/admin/plugins

Obtenir un Plugin

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

Activer un Plugin

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

Désactiver un Plugin

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

Codes d’Erreur

CodeStatut HTTPDescription
NOT_FOUND404Ressource non trouvée
VALIDATION_ERROR400Données d’entrée invalides
UNAUTHORIZED401Jeton manquant ou invalide
FORBIDDEN403Permissions insuffisantes
CONTENT_LIST_ERROR500Échec de listage du contenu
CONTENT_CREATE_ERROR500Échec de création du contenu
CONTENT_UPDATE_ERROR500Échec de mise à jour du contenu
CONTENT_DELETE_ERROR500Échec de suppression du contenu
MEDIA_LIST_ERROR500Échec de listage des médias
MEDIA_CREATE_ERROR500Échec de création de média
SCHEMA_CREATE_ERROR500Échec d’opération de schéma
SLUG_CONFLICT409Le slug existe déjà
RESERVED_SLUG400Le slug est réservé

Points de Terminaison de Recherche

Recherche Globale

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

Paramètres

ParamètreTypeDescription
qstringRequête de recherche (requis)
collectionsstringSlugs de collections séparés par des virgules
statusstringFiltrer par statut (défaut : published)
limitnumberRésultats maximum (défaut : 20)
cursorstringCurseur de pagination

Réponse

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

Suggestions de Recherche

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

Retourne les titres correspondant au préfixe pour l’autocomplétion.

Reconstruire l’Index de Recherche

POST /_emdash/api/search/rebuild

Reconstruit l’index FTS pour toutes les collections ou des collections spécifiques.

Statistiques de Recherche

GET /_emdash/api/search/stats

Retourne les comptages de documents indexés par collection.

Points de Terminaison de Sections

Lister les Sections

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

Obtenir une Section

GET /_emdash/api/sections/:slug

Créer une Section

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

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

Mettre à Jour une Section

PUT /_emdash/api/sections/:slug

Supprimer une Section

DELETE /_emdash/api/sections/:slug

Points de Terminaison des Paramètres

Obtenir Tous les Paramètres

GET /_emdash/api/settings

Mettre à Jour les Paramètres

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

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

Points de Terminaison des Menus

Lister les Menus

GET /_emdash/api/menus

Obtenir un Menu

GET /_emdash/api/menus/:name

Créer un Menu

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

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

Mettre à Jour un Menu

PUT /_emdash/api/menus/:name

Supprimer un Menu

DELETE /_emdash/api/menus/:name

Ajouter un Élément de Menu

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

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

Réorganiser les Éléments de Menu

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

Points de Terminaison de Taxonomies

Lister les Définitions de Taxonomies

GET /_emdash/api/taxonomies

Créer une Taxonomie

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

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

Lister les Termes

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

Créer un Terme

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

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

Mettre à Jour un Terme

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

Supprimer un Terme

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

Définir les Termes d’Entrée

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

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

Points de Terminaison des Zones de Widgets

Lister les Zones de Widgets

GET /_emdash/api/widget-areas

Obtenir une Zone de Widget

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

Créer une Zone de Widget

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

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

Supprimer une Zone de Widget

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

Ajouter un Widget

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

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

Mettre à Jour un Widget

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

Supprimer un Widget

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

Réorganiser les Widgets

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

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

Points de Terminaison de Gestion des Utilisateurs

Lister les Utilisateurs

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

Obtenir un Utilisateur

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

Mettre à Jour un Utilisateur

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

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

Activer un Utilisateur

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

Désactiver un Utilisateur

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

Points de Terminaison d’Authentification

Statut de Configuration

GET /_emdash/api/setup/status

Retourne si la configuration est terminée et si des utilisateurs existent.

Connexion par Passkey

POST /_emdash/api/auth/passkey/options

Obtient les options d’authentification WebAuthn.

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

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

Vérifie le passkey et crée la session.

Lien Magique

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

{
  "email": "user@example.com"
}
GET /_emdash/api/auth/magic-link/verify?token=xxx

Déconnexion

POST /_emdash/api/auth/logout

Utilisateur Actuel

GET /_emdash/api/auth/me

Inviter un Utilisateur

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

{
  "email": "newuser@example.com",
  "role": 30
}

Gestion des Passkeys

GET /_emdash/api/auth/passkey

Liste les passkeys de l’utilisateur.

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

Enregistre un nouveau passkey.

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

{
  "name": "MacBook Pro"
}

Renomme le passkey.

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

Supprime le passkey.

Points de Terminaison d’Importation

Analyser l’Exportation WordPress

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

file: <WXR file>

Exécuter l’Importation WordPress

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

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

Limitation de Débit

Les points de terminaison de l’API peuvent être limités en débit selon la configuration du déploiement. Lorsque la limite est atteinte, les réponses incluent :

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

CORS

L’API prend en charge CORS pour les requêtes des navigateurs. Configurez les origines autorisées dans votre déploiement.