Skip to main content
Skip table of contents

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

.NET SDK

The SDK for .NET/C# is available via nuget.

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, modelViewUrl

Docs

Shared Rhino 7 system

https://sdr7euc1.eu-central-1.shapediver.com

Swagger

Shared Rhino 6 system

https://sdeuc1.eu-central-1.shapediver.com

Swagger

API documentation, Swagger

Please use the table above to find Swagger API documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.