paramate REST API

Introduction

The paramate REST API is a web API for using the trinckle paramate cloud service.

The chapters of this manual cover

• General usage of the API
• Authentication
• Requests to use with a configuration session
• Requests to manipulate the database

General usage of the API

The API is accessible at the url https://api.paramate.trinckle.com

All endpoints use JSON as input and output (content-type: application/json;charset=UTF-8), unless otherwise specified (for raw file uploads and downloads)

Authentication

There are two ways of authentication, depending on which part of the API is used:

Configuration Sessions

Configuration sessions are the main use of the paramate system. A session represents the user journey from starting a configuration of a model to downloading the final configured 3D model.

A typical session consists of these steps:

• 1. Get anonymous token
• 2. Start / initialize configuration session
• 3. Get object information
• 4. Get parameters and their values
• 5. a) In case of client side visualization: Get scene, shader and model files for visualization
• 5. b) In case of server side visualization: Get rendered image
• 6. Set parameters, (eventually upload files) get new object information, and update renderer model or get new rendered image, depending on the type of visualization
• 7. Repeat step 6 until the model is configured to the desired configuration
• 8. Download the model or the finalized model

Admin

To be able to modify configurators, user authentication is needed. After successful authentication, the password can be changed, configurators can be created, modified, and applications can be registered to them.