Integrating 3D Products

This guide explains the overall workflow that partner developers should follow when integrating the Archisketch Open API for the first time.

This is the overall workflow for integrating the Archisketch Open API. Please follow the steps below in order.

1. Issuing an x-api-key

Log in to the Archisketch dashboard to issue your API key. The issued x-api-key must be included in the header of all subsequent API requests.

Make sure to keep your x-api-key secure so that it is not exposed externally.

2. Registering Modeling

Upload your 3D model files to create a modeling asset. The generated modeling ID will be used in the next step.

Register Modeling

3. Registering Components

Create a component based on the modeling asset. The generated component ID will be used in the next step.

Register Component

4. Registering Parametric Components (Optional)

Proceed with this step if you need parametric components that allow users to dynamically adjust parameters such as dimensions and colors.

Register Parametric Component

5. Registering Products

Create a commercial product based on the components.

Register Product