Documentation de l’API

L’API REST du back-office Payload, en lecture : chaque collection publiée est exposée sans authentification, dans le format de Payload (docs, totalDocs, page, totalPages…). L’écriture demande une session ou une clé d’API ; les contenus en brouillon ne sortent jamais sans session. Les fichiers (images, PDF) sont servis sous /api/<collection>/file/<nom>.

Adresse de base : https://demo.rhanb.com/api Télécharger le document OpenAPI (JSON) · Licence Ouverte 2.0 (données fictives de démonstration)

• GET/pagespages

  Lister : Pages

  Les pages éditoriales, avec leur arborescence et leurs blocs.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/pages/{id}pages

  Lire : Page

  Paramètres

  Nom	Type	Description
  id	integer

• GET/actualitesactualites

  Lister : Actualités

  Les actualités publiées.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/actualites/{id}actualites

  Lire : Actualité

  Paramètres

  Nom	Type	Description
  id	integer

• GET/agendaagenda

  Lister : Agenda

  Les événements de l’agenda.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/agenda/{id}agenda

  Lire : Événement

  Paramètres

  Nom	Type	Description
  id	integer

• GET/servicesservices

  Lister : Services

  Les services municipaux de l’annuaire.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/services/{id}services

  Lire : Service municipal

  Paramètres

  Nom	Type	Description
  id	integer

• GET/eluselus

  Lister : Élus

  Les élus du conseil municipal.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/elus/{id}elus

  Lire : Élu

  Paramètres

  Nom	Type	Description
  id	integer

• GET/equipementsequipements

  Lister : Équipements

  Les équipements de la commune, avec leur position sur le plan.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/equipements/{id}equipements

  Lire : Équipement

  Paramètres

  Nom	Type	Description
  id	integer

• GET/demarchesdemarches

  Lister : Démarches

  Les démarches et leur marche à suivre.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/demarches/{id}demarches

  Lire : Démarche

  Paramètres

  Nom	Type	Description
  id	integer

• GET/documentsdocuments

  Lister : Documents et actes

  Les actes et publications ; les documents restreints n’apparaissent pas sans session.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/documents/{id}documents

  Lire : Document

  Paramètres

  Nom	Type	Description
  id	integer

• GET/themesthemes

  Lister : Thèmes

  La taxonomie commune.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/themes/{id}themes

  Lire : Thème

  Paramètres

  Nom	Type	Description
  id	integer

• GET/sitessites

  Lister : Sites et mini-sites

  Le site principal et les mini-sites.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/sites/{id}sites

  Lire : Site

  Paramètres

  Nom	Type	Description
  id	integer

• GET/mediasmedias

  Lister : Médiathèque

  La médiathèque : métadonnées et déclinaisons d’image.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/medias/{id}medias

  Lire : Média

  Paramètres

  Nom	Type	Description
  id	integer

• GET/redirectionsredirections

  Lister : Redirections

  Les redirections actives.

  Paramètres

  Nom	Type	Description
  limit	integer	Nombre de documents par page.
  page	integer
  sort	string	Champ de tri ; précédé de - pour l’ordre décroissant (ex. -datePublication).
  where	object	Filtre, syntaxe where[champ][operateur]=valeur ; opérateurs : equals, contains, in, greater_than, less_than…
  depth	integer	Profondeur de résolution des relations.
  locale	fr | en	Langue des champs localisés.

• GET/redirections/{id}redirections

  Lire : Redirection

  Paramètres

  Nom	Type	Description
  id	integer

• GET/openapi.jsonmeta

  Cette description

• GET/santemeta

  La sonde de santé du back-office