DOCS

API Access

There are two ways to interact programmatically with the 3dverse platform:

  • the Livelink.js SDK, for connecting to a live rendering session, and interacting with the scene in real time.
  • the Asset API, for uploading, managing and monitoring assets.

Both the Livelink.js SDK and the Asset API require an authentication token. Depending on the use case, you have multiple options.

Public Token

This is the quickest and easiest way to connect to a 3dverse Scene with the Livelink.js SDK.

  • The Public Token has read access to all assets inside the Public Folder.
  • It doesn’t have an expiry date and can safely be exposed client side.
  • You won’t be able to identify the identity of your users. The username in session monitoring will appear as {org_name}_{app_name}_{env_name}

The public token can also be passed as user_token to the Management API but will only be authorized for action requiring read access.

Users

In more advanced use-cases, you’ll want to let your users upload source files and manage their 3D assets. In these cases, you’ll need to keep track of who has uploaded what, and who has access to what. This is where User ressources become crucial.

The general workflow is the following:

  • At signup time, create a 3dverse User server-side with the Management API. This outputs a user_id .
  • At login time, use the Management API to generate a User Token server-side and pass it to the client.
  • Use the User Token to create a folder, upload sources files on behalf of the user.
  • Use the User Token to start a rendering session with the Livelink.js SDK.

The User Tokens will have an expiry date, defined at token generation time.

Their access scope will also be defined at generation time and based on which folder the user has access to.

You will be able to monitor Session usage per usage in your Session monitoring dashboard.

API Keys

API Keys are meant to be used server-side, to access the Asset API.

They are created via the Console and are tied to a specific app and environment.

You can restrict the scope and the expiry date at creation time.

Previous
Supported File Formats