DistillerSR API Documentation

DistillerSR API documentation can be found here. It contains instructions on how to use said API and implement it into your system. If something an API error is ever encountered, the documentation can be used to find a solution.

What is in the API documentation?

1. Methods

With the API, you can send, receive, and delete data, so different actions can be used for different results. This is why there are different types of API, called Methods. 

In DistillerSR we have five different types of methods:

1. GET - a method used to retrieve data from a server at the specified resource. 

2. POST - sends data to the API server to create or update a resource.

3. PUT - similar to POST, it sends data to the server to create or update a resource, but this method will overwrite the existing data.

4. PATCH - similar to PUT, but only applies (overwrites) partial modifications to the resource. 

5. DELETE - this method deletes the data. 

The method type is the first point stated in the documentation:

2. Endpoints

For every API call, there is an endpoint. Endpoints are the URLs to the exact page of the resource with which we are going to interact. 

The endpoints are listed in the documentation right below the method type:

3. Authorization 

Just as with every website, you should authenticate prior to performing any actions via the API. The first action in all API interactions with DistillerSR should be an authorization.