Getting started – SDKs, examples, documentation
TypeScript SDK
We provide an SDK for JavaScript, TypeScript, node.js via npm. Please check out how to use it and the examples provided: https://www.npmjs.com/package/@shapediver/sdk.geometry-api-sdk-v2
See the Migration Guide when you have troubles upgrading to the latest version.
.NET SDK
The SDK for .NET/C# is available via nuget.
Python SDK
The SDK for Python 3 is available via pypi.
PHP SDK
The SDK for PHP 8 is available via composer.
Examples
We provide examples of how to use the SDKs on GitHub and .NET Fiddle. Ask us on the Forum if you don’t understand how they work or if you want to suggest further examples to be added.
Some further examples available on Codesandbox:
Description | Codesandboxes |
|---|---|
Demonstrates how the TypeScript SDK can be used to send computation requests, download and display resulting glTF assets, and access further output data. | https://codesandbox.io/s/geometry-backend-sdk-with-ui-v3-vv7xnz?file=/src/index.ts https://codesandbox.io/s/geometry-backend-sdk-json-in-out-3dfk7p?file=/src/index.ts |
API endpoints of shared systems
The following table shows the API endpoints of our shared Geometry Backend Systems.
In the context of the ShapeDiver Viewer the API endpoint is called modelViewUrl.
Geometry Backend System | API endpoint, | Docs |
|---|---|---|
Shared Rhino 7 system | ||
Shared Rhino 6 system |
API documentation, Swagger
Please use the table above to find Swagger API documentation.