🧑‍🏫REST API

The REST API uses RESTful architecture to provide a simple, consistent interface. One of the main advantages of the REST API is that it doesn't require many tools to access your data.

REST resources and requests

The REST API is based on the use of resources: data elements in MeltingSpot, such as lives, collections, search results, etc. Each resource is exposed via a URL and can be accessed by sending HTTP requests to the corresponding URL. Depending on the resource you wish to access, and how you construct an HTTP request, you can perform several types of operations:

• Create resources

• Update resources

• Delete resources

• Retrieve data

• Search your resources

You can send HTTP requests using a variety of software tools. However, no matter how you submit your requests, the elements don't change. A typical request consists of these elements.

• URL: this is the path to a resource in MeltingSpot.

• HTTP method: this is the action you wish to perform on the resource in question

  • GET: retrieves data

  • POST: to create data

  • PUT: to modify data

  • DELETE: deletes data

• Headers: transmit parameters and customize HTTP request options.

• Body: allows you to provide additional information, such as the first name of the spotMember you wish to add to a given collection.