Developer Documentation
Technical documentation for developers embedding Amaspace 3D configurators in custom applications using React or Vanilla JavaScript.
What is this?
The Amaspace 3D Editor SDK is a JavaScript library that lets you embed interactive 3D configurators in your own applications with full programmatic control.
Who is this for?
Frontend developers who need:
- Custom configurator UI/UX
- Programmatic control over 3D scenes
- Integration with existing applications
- Advanced features (AR, custom cameras, animations)
Not a developer? Use our no-code integrations instead (Shopify, WooCommerce, custom embed).
What you can build
- Custom configurators with your own UI and branding
- Programmatic control over cameras, materials, and animations
- AR & VTO experiences (Augmented Reality, Virtual Try-On)
- Headless implementations without using Amaspace UI
Quick Start
Install via npm:
npm install @amaspace-editor/editor-3d
React example: Import EditorConstructor and use it with your assetId and apiKey.
Vanilla JS example: Include the script tag and call window.playerInit with your configuration.
Key Features
- React & Vanilla JavaScript support
- TypeScript definitions included
- Hooks-based API for React
- Mode switching (VIEWER, EDITOR, TRYON)
- Camera, material, and animation control
- Custom objects and lighting
- AR and Virtual Try-On support
What’s inside
- Getting Started — Installation and basic setup
- API Reference — Complete component and hooks documentation
- Examples — Code snippets for common tasks
Getting Started
Install and integrate the powerful 3D editor library for React and Vanilla JavaScript.
API Reference
Provide a comprehensive API reference for the EditorConstructor and its features.
Examples
Implement various functionalities for the 3D editor, including options, camera, material, AR, and VTO.