API Reference (API endpoints description)
The structure of request bodies and responses is available in our Onsite API Swagger documentation
Request URL (below as ‘API’): https://api.onsite.materialise.com/v1
| ENDPOINT | DESCRIPTION |
| Authorization | Used to get you authorized |
|
POST API/token |
Receive authorization token Returns an authorization token for provided client ID and client secret. |
| Model related | Used for uploading 3D models, receiving model parameters and processing status |
|
POST API/models
GET API/models/{id}/status
GET API /models/{id} |
Upload 3D model Upload a 3D model to receive a modelID. modelIDs are used to create products for quotations.
Get 3D model processing status Check the processing status of an uploaded 3D model.
Get 3D model parameters Get the dimensions, volume, and surface area of a processed 3D model. |
| Technologies related | Provides a list of IDs for all available technologies and materials |
|
GET API/technologies |
Get a list of available technologies and materials Receive IDs of available technologies, materials, and finishes. technologyIDs and materialIDs are used together with modelIDs to create products |
| Product related | Used to create products and receive production costs |
|
POST API/products
POST API/products/{id}/price
GET API/products/{id}/services |
Create a product in selected material Create a product in selected material based on the previously uploaded model and receive a productID.
Receive production price for a product Receive production price for a product in specified currency.
Get available services for a product Receive the list of available services for a specific product. |
| Delivery Address related | Used for adding a new Delivery Address for a Quotation |
|
POST API/delivery-address |
Create a new Delivery Address Create an empty quotation and receive deliveryAddressID. |
| Quotation related | Used for quotation related actions: create, update, order, and delete |
|
POST API/quotations
POST API/quotations/{id}/addresses
POST API/quotations/{id}/order
GET API/quotations
GET API/quotations/{id}
DELETE API/quotations/{id} |
Create an empty quotation Create an empty quotation and receive quotationID. Quotations can include multiple products and required to create orders.
Add addresses to a quotation Add shipping and invoice address for a specific quotation.
Place an order Place an order for specific quotationID.
Get a list of quotations Receive a list of active quotations.
Get quotation details Receive details of a specific quotation including total cost, transport cost, and the list of items in that quotation.
Delete quotation Delete unnecessary quotation from the list of active quotations. |
| Quotation Item related | Used for adding and deleting products in quotations |
|
POST API/quotations/{id}/items
DELETE API/quotations/{id}/items/{quotationItemId} |
Add items to quotations Add a previously defined product to a specific quotation and receive quotationItemID.
Delete items from quotations Delete a quotation item form a specific quotation |