# Présentation

Les détails de l'API sont disponibles sur Postman.

{% embed url="<https://documenter.getpostman.com/view/845751/SVfH1CsN>" %}

**L'API vous donne accès à l'ensemble des données disponibles sur Mon Butin.**

Les requêtes POST/PATCH présentes ici sont indiquées avec un content type `application/x-www-form-urlencoded` uniquement par praticité (permet de décrire chaque paramètre de la requête).

Il est tout à fait possible d'envoyer directement un objet JSON en utilisant le content type `application/json`. Les noms de variables sont alors identiques.

### Environnements disponibles <a href="#rest-urlapi" id="rest-urlapi"></a>

Trois environnements sont accessibles :&#x20;

* **Production** pour la version actuelle de l’application ;
* **Edge** pour la version actuelle mise à jour avec d’éventuels correctifs et permet de s’assurer de la stabilité de ces derniers dans un environnement identique à celui da la production ;
* **Test** pour la version à venir actuellement en développement ;

Mis à part le code de l’application, **Production** et **Edge** partagent les mêmes instances.&#x20;

**Test** est sur une instance entièrement séparée.&#x20;

### API REST - Le CRUD dédié à vos données <a href="#api-apirest" id="api-apirest"></a>

L'API REST est dédiée aux actions CRUD sur les objets enregistrés en base de données.

### API JSON-RPC - Intéragir avec l’application <a href="#api-apirpc" id="api-apirpc"></a>

L'API JSON-RPC est utilisée pour executer des actions sur le serveur ou effectuer des traitements sur les objets enregistrés.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mon-butin.fr/api/presentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
