> For the complete documentation index, see [llms.txt](https://help.meltingspot.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.meltingspot.io/manage-spot/integrations/api/rest-api.md).

# REST API

Pour ceux qui débutent dans l'utilisation d'API... voici quelques infos sur l'architecture choisie :)

Notre API est basée sur l'architecture RESTful pour fournir une interface simple et cohérente. L’un des principaux avantages est qu’elle ne nécessite pas beaucoup d’outils pour accéder à vos données !

## Ressources 

L'API REST est basée sur l'utilisation de ressources MeltingSpot tels que les lives, les membres, les résultats de recherche, etc. Chaque ressource est exposée via une URL et est accessible en envoyant des requêtes HTTP à l'URL correspondante. En fonction de la ressource à laquelle vous souhaitez accéder et de la manière dont vous construisez une requête HTTP, vous pouvez effectuer plusieurs types d'opérations : 

* Créer des ressources
* Mettre à jour des ressources
* Supprimer des ressources
* Récupérer des données et chercher dans vos ressources  

## Requêtes REST

Vous pouvez envoyer des requêtes HTTP à l'aide de divers outils logiciels. Cependant, quelle que soit la manière dont vous soumettez vos demandes, les éléments suivants ne changent pas. Une demande typique est constituée de ces éléments :

* **URL** : il s'agit du chemin d'accès vers une ressource dans MeltingSpot.
* **Méthode HTTP** : il s'agit de l'action que vous souhaitez effectuer sur la ressource en question 
  * `GET` : permet de récupérer de la donnée
  * `POST` : permet de créer de la donnée
  * `PUT` : permet de modifier de la donnée
  * `DELETE` : permet de supprimer de la donnée
* **Headers** : permet de transmettre des paramètres et personnaliser les options des requêtes HTTP.
* **Body** : permet de fournir des informations supplémentaires (par exemple le prénom du spotMember que l'on souhaite ajouter à telle ou telle collection)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.meltingspot.io/manage-spot/integrations/api/rest-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.