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 API?

An API (Application Programming Interface) allows different applications to interact with each other. You can use the DistillerSR API to send information to DistillerSR or retrieve data from it.

• Benefits:

  • Automation: Automate repetitive tasks like importing references or exporting reports on a scheduled basis.

  • Data Exchange: Transfer data between DistillerSR and other applications or repositories.

API Fundamentals

Before making an API call, it's helpful to understand the three core components of any API interaction:

1. Methods The method tells the API what kind of action to perform. DistillerSR supports five methods:

   • GET: Retrieves data from a server.

   • POST: Sends new data or updates existing data to the server.

   • PUT: Overwrites a resource with new data.

   • PATCH: Applies a partial modification to a resource.

   • DELETE: Removes data from the server.

2. Endpoints An endpoint is the specific URL for the resource you want to interact with. The endpoint is listed in the documentation right below the method type.

3. Authorization Just as with any website, you must authenticate yourself before performing any actions. Your first API interaction with DistillerSR should always be for authorization.

Connecting and Running Requests

1. Get Your Authorization Token:

   • Open Postman and create a new request.

   • Set the request method to POST.

   • Enter the DistillerSR login URL: https://v1serv-prod.evidencepartners.com/api/v1/auth/

   • Navigate to the Authorization tab and select Basic Auth.

   • Enter your DistillerSR username and password.

   • Click Send. This will generate an authorization token. Copy this token for future requests.

2. Make an API Request (e.g., Get Project IDs):

   • Create a new request tab in Postman.

   • Set the request method to GET.

   • Enter the URL: https://v1serv-prod.evidencepartners.com/api/v1/projects

   • Go to the Authorization tab and select Bearer Token.

   • Paste the authorization token you copied from the previous step.

   • Click Send. The API will return the IDs for all projects under your account.

JSON Validation Requirements

To ensure data integrity, any JSON file you import must meet the following criteria:

• Form names, level names, IDs, question text, and answer text must all match between the JSON file and the project.

• All RefIDs must be valid and cannot be duplicates.

• All users associated with the response sets in the file must be an Account Administrator of the project.

• The project can only have one matching Level/Form/Question/Answer configuration.