REST : manipuler les données

L'API REST permet de travailler directement sur les données enregistrées en base de données.

Généralités

Les requêtes REST utilisent les actions suivantes :

Méthode	Action	Description
GET	Get	Chargement d'un ou plusieurs objets. Charger une collection : /rest/objet/ Charger un élément par son ID : /rest/objet/id
POST	Create	Création d'un nouvel objet.
PUT	Update	Mise à jour d'un objet existant.
DELETE	Delete	Suppression d'un objet.

Endpoints

Environnement	Endpoint
Production	https://api.mon-butin.fr
Edge	https://api-edge.mon-butin.fr
Test	https://api-test.mon-butin.fr

Références à d'autres objets

Par convention, les références externes à d'autres objets adopte la syntaxe suivante : nomObjet_id.

Pour un objet file par exemple, ce sera file_id.

Seul l'ID de l'objet est retourné, sauf mention contraire.

Dates

Les dates sont généralement retournées sous 2 formes :

• la date au format « Heure Unix » ;
• la date au format ISO-8601 (nom de variable identique avec suffixe -8601 ).

Pagination des résultats

Une requête GET sur un endpoint sans id retourne la liste complète des données. Il est possible d'utiliser la pagination à l'aide des paramètres d'URL suivants :

• limit indique le nombre maximum de résultats à retourner

• offset pour indiquer le point de départ des résultats à retourner (correspond généralement à limit * page)

Recherche

Les requêtes GET sur collection complète peuvent bénéficier du filtrage des résultats. Dans ce cas il faut passer chaque élément en paramètre d'URL avec la syntaxe suivante : filters[attribut]=valeur.

Par exemple, pour réccupérer la liste des fichiers déjà attachés à une recette ou une dépense : /rest/files?filters[isAttached]=1

Liste des objets disponibles

BankAccount BankStatus Customer Depreciation File FileTag Income Outcome PaymentMode Provision RecurringIncome RecurringOutcome Stack Supplier YearlyResult