Introduction: server-side API
  • Dark
    Light

Introduction: server-side API

  • Dark
    Light

Below are high level explanations regarding the purpose of the Threekit server-side APIs.

Files API - Used for uploading and retrieving files to/from the Threekit Platform CDN. Main usage from an implementation standpoint is for uploading assets into an organization in conjunction with the Asset API.

Catalog API - Used for retrieving a list containing all item data from all items matching your specified query accessible by the authentication token used. Can be useful for mapping item names to item Ids when using the Configurator API.

PBR JSON Import - Used for importing material and textures into the platform in a custom format that matches the platform’s data structure closely.

Product Import API - Used for importing and updating items, along with all their metadata, into the platform using JSON format. Can be used for updating multiple items that match the criteria defined in the query object.

Configurations API - Used for saving and accessing saved configurations. It is used by the sharing function to resume the configurator state.

Asset Job API - Used for importing and exporting assets to/from the platform. For importing, used in conjunction with the Files API.

Was this article helpful?