🧑‍🏫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)