Integrations
- 1 REST API
- 1.1 Use Cases
- 2 Webhooks and CSV Export
- 2.1 Webhooks
- 2.1.1 List of available Webhooks
- 2.1.2 Authorization
- 2.2 CSV Export
- 2.1 Webhooks
- 3 Zapier
- 4 3D Viewer SDK
- 5 CSV Import
- 6 Integration with SAP
- 7 Integration with Magics
- 8 Integration with am-flows AmVision part sorting solution
- 9 Machine Connectivity
- 10 Single Sign On
- 11 Python Scripts
3YOURMIND offers various technologies to integrate with 3rd party software. This page gives an overview of those technologies and their use-cases.
REST API
3YOURMIND offers a RESTful API based on JSON and HTTP(S).
The REST API is available for all customers (on-prem or cloud).
The technical documentation for the REST API can be found at https://demo.3yourmind.com/apidocs/.
An API token is required to use the REST API. It can be generated in the 3YOURMIND admin panel (www..your-domain.com/admin). Customers who do not have access to the admin panel need to contact the 3YOURMIND support team to obtain a token.
(Click here to see how to use the API token)
The documentation of the API contains only selected endpoints that are actually needed and used. More endpoints are added continuously according to identified needs.
Use Cases
Common use cases for the API, can be found in the following documentation: API Use Cases
Webhooks and CSV Export
Both Webhooks and the CSV Export feature can be used to transfer data from 3YOURMIND to a 3rd party system.
With both tools, similar goals can be achieved. Here is a comparison that should help you decide which technology to use:
| Webhook | CSV Export |
---|---|---|
Format | JSON | CSV |
Real-time |
|
|
Nested data supported |
|
|
Level of automation | fully automated | manual steps may be needed |
Technology fit | Web based software | Excel / Desktop software |
Complexity | medium | low |
Supported data | Requests, Quotes, Orders, Jobs and more | Orders, Jobs, AMPI Parts |
Webhooks
While the REST API always needs to be triggered by an external event (something happens outside 3YOURMIND, e.g. an order was placed in another system), webhooks can be used to retrieve data when something happens inside of the 3YOURMIND software. They get triggered in real-time.
To make use of webhooks, a 3rd party service must be running somewhere and be accessible by the 3YOURMIND server via a URL / path. Technically, webhooks are a synchronous HTTP(S) call from the 3YOURMIND server to a 3rd party service.
Upon request, all webhooks can be sent from a static IP (52.29.154.152)
List of available Webhooks
Webhook | When is it triggered? | What is sent?* |
---|---|---|
When a Request For Quote is created in the User- or Service Panel. | Request For Quote object | |
When a Quote is created in the User- or Service Panel. | Quote object | |
When an Order is created in the User- or Service Panel. | Order object | |
When an Order is moved from one status to another in the Service Panel. | Order object + status change. | |
When an Order is moved into a production state. | Order object | |
When a Job is finished (can also be triggered by machine connectivity). | Job Object | |
When a Job is scrapped. | Job Object | |
When a Job is started. | Job Object | |
When new user finalizes their registration. | User-related data, such as FirstName, LastName, Address, etc. | |
When the user’s data gets updated. | User-related data, such as FirstName, LastName, Address, etc. | |
When a sales transaction gets rejected by the service | Transaction type, and transaction object (e.g. Quote object or Order object) |
*Webhook events may include (expiring) download links to 3D data.
Authorization
You can configure an Authorization
field for every webhook. It will be attached as an Authorization
header when calling the configured URL.
Another option is to include user credentials directly in the configured URL. E.g.: https://user:password@domain.com
. They will be removed from the URL before sending and added as a base64 encoded Authorization
header with a Basic
prefix. E.g.: Basic asdx241==
CSV Export
List of available CSV Exports
Some data can be exported as CSV which is useful for simplistic integrations to various 3rd party systems or for reporting purposes.
What | Sample file |
---|---|
List of Orders and Order Lines. Note that in the CSV Export the rows correspond to order lines. The order data is duplicated if an order contains multiple lines. This is a technical limitation of CSV. |
|
List of MES Jobs |
|
List of PLM/AMPI Parts Note that many columns are configurable in the PLM. |
|
Zapier
Zapier is a SaaS solution that makes it easy to connect 2 web-based applications. It makes use of our Webhook system. To check if an application is supported, see https://zapier.com/apps
3D Viewer SDK
Our viewer can be integrated into any other Frontend. See 3D Viewer SDK.
This can be used in combination with our REST API to get printability information (wall thickness check, bounding box check, multi-shell check), geometric information (volume, area, dimensions, convex hull, concave hull, …), and the optimized 3D file (using our mesh healing algorithms).
CSV Import
PLM data can be imported for analysis in the PLM/AMPI. See CSV Import. The source of the data can be SAP, Teamcenter, or other PLM systems.
Integration with SAP
3YOURMIND is integratable with SAP for the following use-cases:
Transfer customer data to 3YOURMIND
Transfer Sales Transactions (RFQs, Quotes, POs) from 3YOURMIND to SAP
Transfer Production Data from 3YOURMIND to SAP
Integrations to SAP are realized through development with 3YOURMIND partners.
Integration with Magics
See Creating Jobs via Magics CSV Import
Integration with am-flows AmVision part sorting solution
Automated part sorting can be enabled via the integration to the AmVision solution provided by am-flow. Parts and workflow steps are automatically shared with the AmVision machine and can be sorted according to their next step or order number after printing. For further details see Sorting Printed Parts with AM-Vision
Machine Connectivity
For connecting 3D Printers and post Processing machines, see Machine Connection
Single Sign On
We support Single Sign On via OAuth 2 including OIDC. See Single Sign On with OAuth 2
Python Scripts
We have some (unpublished) python scripts to help with creating orders and catalog parts with our REST API. Please contact us if you are interested in using them.