@shapediver/sdk.platform-api-sdk-v1

ShapeDiver Platform SDK

ShapeDiver is a cloud platform that provides the right tools and scalable infrastructure to help you transform your Grasshopper files into online applications. It allows you to share the power of Grasshopper and Parametric Design with partners, clients and other key stakeholders wherever they are.

The ShapeDiver Platform SDK allows to access the functionality of the ShapeDiver Platform (or white labelled instances of it) by means of the ShapeDiver Platform API. The SDK exposes all TypeScript-types describing request and response objects.

The authentication system is based on JWT tokens, which the SDK allows you to request from the ShapeDiver Platform using the OAuth 2.0 functionality integrated with the ShapeDiver Platform API.

Usage

• Add npm package:

  npm i @shapediver/sdk.platform-api-sdk-v1
  

• Import constructor function:

  import { create } from '@shapediver/sdk.platform-api-sdk-v1';
  

• Create and authorize client:

  const client = create({clientId: "CLIENT_ID", baseUrl: "SHAPEDIVER_PLATFORM_API_ENDPOINT"});
  await client.authorization.passwordGrant("USERNAME", "PASSWORD");
  

Versioning

We take care to provide backwards compatibility for older versions of the SDK and the API, but might introduce breaking changes in case of major version upgrades. New features of the SDK might be limited to newer versions of the API. We recommend always using the newest SDK version out there.

Support

• Plaform Backend documentation
• ShapeDiver Help Center
• Forum

If you have further questions, reach out to us.

Find out more about ShapeDiver right here!

Licensing

The ShapeDiver Platform SDK is released under the MIT License.