How to use this page

This documentation provides a high level overview of some of the common use cases for the 3YOURMIND RESTful API.

More details for each use case listed below, can be found by clicking on the respective title. In some cases, these more detailed descriptions will include examples for how the API request can be formatted. Where relevant, the required endpoints will be listed in the use case description and the link to the endpoint description, as defined in the API documentation, will be included.

If there is a common use case which you think would be valuable to be included as part of this documentation, or if you have any questions about the scenarios outlined below, please feel free to reach out to the Technical Support Team with your queries or suggestions.

API Documentation

To reach the API documentation for your platform, please append the /apidocs/ endpoint to the site URL (e.g, order.yoursite.com/apidocs/).

Authentication

An API token is required to use the REST API and this token is generated in the admin panel (www..your-domain.com/admin). In the admin panel, open the list of users and click ‘Create token’ next to the chosen user.

Open

Lists of Users in Admin Panel

Please ensure that this user profile has the necessary permissions to complete the actions specified in the API request. More information on User Roles, can be found in the following documentation: Roles & User Rights.

Customers who do not have access to the admin panel need to contact the 3YOURMIND support team to obtain a token.

The API Token can be used as outlined in the API Documentation: API Use Cases | API Documentation

API Use Cases

Create a Quote based on a RequestForQuote while choosing a custom price for the Quote-Lines

Creating a Quote from a Request, whilst specifying a new price for the newly created Quote.

Upload an Internal Attachment

Upload an attachment internally (e.g. to a Quote, Order, Request etc.).

Edit a Quote

Create a new Quote from an existing Quote with specified edits.

Upload a File into a Basket

Create a basket and upload a 3D file to this newly created basket.

Programmatically Upload Files and Redirect your Users to the 3YOURMIND Frontend

If your own application generates 3D data and you want to use the Order Management System, you can upload 3D models and redirect the user to the 3YOURMIND platform.

Place Orders Programmatically

This is useful when the order is created in another system and this order should be placed in the 3YOURMIND system for tracking and processing.

Place Orders from a Catalog Item

Add items from the Digital Catalog to a basket and place an order.

Create / List Customers Programmatically

Create users in the platform and specify their user settings, as well as generating a list of all users of the platform.

Get Prices for 3D Models

Upload 3D files to a basket and retrieve the prices for materials, services and post-processings generated by the 3YOURMIND pricing engine for these uploaded files.

Analyze and Optimize 3D Models

Upload 3D files to a basket for analysis and optimization and retrieve the files’s printability and geometric information, as well as the optimized 3D file.

Transfer Sales Transactions into Another System (ERP, CRM, etc.)

Transfer data from the 3YOURMIND platform to your own system (e.g. CRM, ERP, Accounting etc.) when a user places requests, quotes or orders.