API

Une API REST complète pour vos intégrations

Fatplant expose l'intégralité de ses contenus via une API REST normalisée, construite sur API Platform. Intégrez vos applications front-end, mobile ou tierces en quelques lignes.

Architecture

API Platform & REST

Fatplant utilise API Platform v4 (PHP/Symfony) pour exposer ses ressources éditoriales. Chaque ressource — article, page, catégorie, média, tag — dispose d'endpoints REST standardisés respectant le format JSON-LD / Hydra.

La documentation interactive OpenAPI est générée automatiquement et accessible à /api/docs sur chaque instance. Testez les endpoints directement depuis votre navigateur sans aucune configuration.

Les endpoints publics (lecture seule) sont disponibles sans authentification sous /api/public/*. Les opérations d'écriture et les contenus privés nécessitent un token JWT.

Endpoints publics `/api/public/*`

Lecture de tous les contenus publiés sans authentification. Idéal pour les front-ends découplés (headless).

Authentification JWT

Tokens JWT avec refresh automatique. Scopes par rôle (admin, rédacteur, lecteur). Compatible OAuth 2.0.

JSON-LD & Hydra

Format normalisé avec pagination, filtres, tri et relations liées. Facilite la découverte automatique des ressources.

Documentation interactive

Interface Swagger UI / ReDoc intégrée sur /api/docs. Testez en live depuis votre instance.

Exemples

Premiers pas avec l'API

Lister les articles publiés (public)

Aucune authentification requise. Remplacez votre-instance.fr par le domaine de votre instance Fatplant.

# Récupérer la liste des articles publiés
curl -s https://votre-instance.fr/api/public/articles \
  | jq '.["hydra:member"][] | {id, title, publishedAt}'

Récupérer un article précis

Passez l'identifiant de l'article dans l'URL. La réponse inclut le titre, le contenu structuré, les catégories et les tags.

# Récupérer un article par son identifiant
curl -s https://votre-instance.fr/api/public/articles/42 \
  | jq '{title, content, categories, tags}'

Authentification JWT (flux complet)

Obtenez un token en échangeant vos identifiants, puis utilisez-le dans le header Authorization pour accéder aux endpoints protégés.

# 1. Obtenir un token JWT
curl -s -X POST https://votre-instance.fr/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username":"admin@exemple.fr","password":"motdepasse"}' \
  | jq '.token'

# 2. Utiliser le token pour accéder aux endpoints protégés
curl -s https://votre-instance.fr/api/articles \
  -H "Authorization: Bearer <votre-token>"

Ne stockez jamais votre token JWT dans le code source ou dans localStorage en production. Utilisez des cookies HttpOnly sécurisés ou un stockage serveur.

Ressources

Aller plus loin

Documentation complète

Référence de tous les endpoints, paramètres de filtrage, formats de réponse et codes d'erreur.

Lire la doc API

Guide de démarrage rapide

Déployez une instance locale et effectuez votre premier appel API en moins de 10 minutes.

Quickstart

Swagger UI en live

Accédez à la documentation interactive directement sur votre instance Fatplant pour tester en conditions réelles.

Voir sur GitHub