Endpoints de l’API REST

Pages, consignes, images et fichiers hébergés


Authentification

Toutes les routes documentées ici utilisent :

Authorization: Bearer <votre_cle_api>

Le contenu JSON est envoyé avec Content-Type: application/json.


Pages

Méthode Endpoint Description
GET /api/pages Lister les métadonnées des pages
GET /api/pages/markdown/[slug] Lire le Markdown brut
POST /api/pages Créer une page
PATCH /api/pages Modifier une page
DELETE /api/pages Supprimer une page

Paramètres d’une page

Paramètre Type Création Description
slug_page string Obligatoire Slug unique et immuable
markdown string Obligatoire Document Markdown complet
short_title_page string Optionnel Libellé du menu
long_title_page string Optionnel Titre complet
description_page string Optionnel Description SEO
position_menu_page number Optionnel 0 masque du menu principal
position_submenu_page number Optionnel 0 masque du sous-menu
id_parent_page integer/null Optionnel ID de la page parente
show_date_page integer Optionnel 0 ou 1
show_pdf_button_page integer Optionnel 0 ou 1

Créer une page

{
  "slug_page": "ma-page",
  "short_title_page": "Ma page",
  "long_title_page": "Ma nouvelle page",
  "description_page": "Description SEO",
  "markdown": "# Titre\n\nContenu.",
  "position_menu_page": 1,
  "position_submenu_page": 0,
  "id_parent_page": null,
  "show_date_page": 1,
  "show_pdf_button_page": 1
}

Le slug vide est réservé à la page d’accueil.

Modifier une page

Avant un PATCH, lire le Markdown actuel, appliquer les changements, puis transmettre le document complet final avec slug_page. Le slug lui-même ne peut pas être modifié.

La page d’accueil ne peut pas être supprimée.


Consignes utilisateur

Méthode Endpoint Description
GET /api/consignes Lister les consignes privées
GET /api/consignes/markdown/[slug] Lire une consigne
POST /api/consignes Créer une consigne
PATCH /api/consignes Modifier une consigne
DELETE /api/consignes Supprimer une consigne

Une consigne utilise slug_page, markdown et, facultativement, les champs de titre et de description. Elle est privée et ne figure jamais dans le rendu public.

Voir Consignes utilisateur.


Images

Méthode Endpoint Description
POST /api/images/formData Importer depuis image_url
POST /api/images/base64 Importer le champ image en base64

Paramètres communs : slug_image, alt_image et max_size optionnel.

Voir Images.


Fichiers

Méthode Endpoint Description
GET /api/files Lister les fichiers et url_file
POST /api/files/url Importer depuis file_url
POST /api/files/base64 Importer file avec filename
DELETE /api/files Supprimer avec slug_file

Voir Fichiers hébergés.


Codes et messages d’erreur

Les erreurs sont retournées en JSON avec un message explicatif. Les causes fréquentes sont :