Welcome to our REST API platform, where we offer a diverse range of services to meet your needs. As you explore our APIs, you may encounter various request methods, such as GET, POST, PUT, and DELETE, each serving specific purposes to facilitate data retrieval and interaction with our systems.

Let’s delve into how these request methods are utilized within our REST APIs.

​
Understanding REST APIs

REST, or REpresentational State Transfer, APIs are designed to enable communication between different software systems over the internet. They follow a set of architectural principles that promote scalability, flexibility, and simplicity in data exchange. REST APIs use standard HTTP methods to perform different actions on resources, making them widely adopted for web services.

​
Request Methods in REST APIs

​
GET Method

The GET method is commonly used for retrieving data from a server. It is ideal for fetching information that is publicly available and does not involve modifying server-side resources. GET requests are sent via the URL, making them easy to use for simple data retrieval operations.

​
POST Method

Unlike the GET method, the POST method is used for creating or updating resources on the server. It allows for sending complex data structures in the request body, making it suitable for operations that involve submitting data or performing actions that require additional parameters beyond simple URL queries.

​
PUT Method

The PUT method is used to update or replace an existing resource on the server. It is commonly employed for operations where the client specifies the resource’s new state or properties that need to be updated.

​
DELETE Method

The DELETE method is used to remove a specific resource from the server. It is employed when a client wants to delete a resource identified by a specific URI.

To summarize:

  • GET: Retrieve data from the server.
  • POST: Create/update resources on the server or retrieve data from the server with complex filtering criteria.
  • PUT: Update or replace existing resources.
  • DELETE: Remove specific resources from the server.

By incorporating a variety of request methods like GET, POST, PUT, and DELETE in our REST APIs, we provide you with a comprehensive toolkit to interact with our services efficiently.

Whether you are retrieving data, submitting information, updating resources, or deleting content, our APIs are designed to support your diverse needs and enhance your digital experience.

​
Special mention: output APIs using POST method

Some of our output APIs utilize the POST method instead of the more commonly used GET method. This decision is based on the complexity of the input filters required to retrieve the desired output. Here’s why certain output APIs are designed to use the POST method:

​
Complexity of Input Filters

  • Advanced Filtering: The output APIs that use the POST method often involve complex filtering criteria that cannot be easily accommodated within the constraints of a GET request’s query parameters.

  • Large Data Sets: When dealing with large data sets or intricate search parameters, using the POST method allows for more flexibility in structuring and transmitting the input data to the server.

​
Benefits of Using POST for Output APIs

  • Enhanced Security: POST requests can securely transmit sensitive data, such as detailed filtering criteria, without exposing it in the URL.

  • Data Integrity: By sending filter parameters in the request body, POST requests ensure that the input data remains intact and is not limited by URL length restrictions.

By leveraging the POST method for certain output APIs, we aim to provide you with a robust and flexible mechanism to access and process data effectively, especially when dealing with intricate filtering requirements.

If you have any questions or need assistance in utilizing these APIs, our team is here to support you every step of the way.

Authentication