FlowerDocs Core expose ses services en tant que web services REST pouvant être consommés depuis différentes technologies.

URL de base

Tous les endpoints REST sont exposés sous :

{host.core}/rest/

Authentification

Chaque requête doit inclure un header token. Obtenez un token en vous authentifiant via :

POST {host.core}/rest/authentication HTTP/1.1
Content-Type: application/json

Consultez l’exemple d’authentification pour plus de détails.

Opérations courantes

L’API REST suit un modèle CRUD cohérent pour tous les types de ressources :

Opération	Méthode HTTP	Schéma d’URL
Récupération	`GET`	`/rest/{ressource}/{ids}`
Création	`POST`	`/rest/{ressource}`
Modification	`POST`	`/rest/{ressource}/{ids}`
Suppression	`DELETE`	`/rest/{ressource}/{ids}`

Où {ids} correspond à un ou plusieurs identifiants séparés par des virgules.

Type de contenu

Tous les corps de requête et de réponse utilisent application/json, à l’exception des endpoints d’upload de fichiers qui utilisent multipart/form-data.

Opérations par lot

La plupart des endpoints acceptent des tableaux, permettant de créer, modifier ou supprimer plusieurs éléments en une seule requête.

Note importante sur les modifications

Les modifications REST fonctionnent sur le principe de remplacement intégral : les champs non renseignés seront vidés. Il faut envoyer la totalité de l’objet et pas seulement les informations à modifier. Il est recommandé de d’abord récupérer la ressource, effectuer les changements, puis appeler le endpoint de modification.

Documentation Swagger

La documentation de cette API est fournie à travers Swagger exposé par FlowerDocs Core sous le chemin {host.core}/swagger-ui/index.html. Vous pouvez également retrouver le Swagger de notre environnement de démo en ligne ici.

Exemples

Des exemples d’utilisation détaillés pour chaque type de ressource sont disponibles dans la section exemples.