ShapeDiver is a cloud platform for building online applications based on parametric 3D files made with Rhinoceros 3D and Grasshopper.
Using the ShapeDiver Geometry Backend API allows accessing ShapeDiver models without using the ShapeDiver Viewer. The SDKs provide the functionality to communicate with a specific version of our Geometry Backend API, and they expose all TypeScript-types describing request and response objects.
The authentication system for the Geometry Backend API is based on ticket objects and JWT tokens, which are handled by the ShapeDiver Platform. You can obtain tickets and JWT tokens
- using your account on the ShapeDiver Platform (tickets only)
- or programmatically using the ShapeDiver Platform API (both tickets and JWT tokens).
An SDK for the ShapeDiver Platform API will be released soon.
When obtaining a ticket for your model from the ShapeDiver Platform, please be aware that you will need a
- ticket for direct embedding in case you are accessing the Geometry Backend API from a web browser, or a
- ticket for backend access in case you are accessing the Geometry Backend API from an arbitrary client application that is not a web browser.
This repository contains the following SDKs to communicate with the ShapeDiver Geometry Backend API:
-
There might be more in the future 🚀
We take care to provide backwards compatibility for all older versions. However, new features might be limited to newer API versions. Therefore, we recommend always using the newest API version out there.
If you have questions, please use the ShapeDiver Help Center.
You can find out more about ShapeDiver right here.
This project is released under the MIT License.