Introduction: Server-Side API
  • Dark

Introduction: Server-Side API

  • Dark

The following is a brief explanation of the purpose for each server-side API.

Analytics API - The purpose of the analytics service is to capture session information of a user interacting with Threekit configurators/viewers. Customers can access raw analytics data from Threekit for use in their Business Intelligence solutions.

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

Assets API - This is the data model to store all of the Assets that exist in your org; Items, Models, Materials, Textures, etc.

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.

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

Customers API - Allows for tracking of where an order is being placed related to a specfic platform.

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.

Jobs API - The underlying Jobs system.

Layers API - The layers service is a way to keep track of renders and exports of specific assets and their configurations. For example if there is an asset with 10 different configurations, it is not ideal to generate a render for all 10 configurations every single time a render job is triggered. Generate it once, make sure it is stored in layer-service, and just call the layer service to fetch that particular file.

Orders API - This API is designed to be used by connectors, for example, shopify integration. If an order is placed in a app like shopify, those order details should also be stored in our database.

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. Also used to update configuration attributes and rules.

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

Webhooks API - Webhooks can be used to trigger a number of things in the platform on the basis of some event.

Was This Article Helpful?