For agencies and developers
How a web agency or a developer uses the iJewel3D embeds and Web SDK to build 3D jewellery pages for a client.
You build websites and stores for jewellery businesses. iJewel3D gives you the 3D part: the viewer, the configurators and the engine. The viewer is not a store, a cart or a checkout. Your client keeps the e-commerce platform.
There are three paths, in order of control.
| Path | What you get | Note |
|---|---|---|
| iframe | One line of HTML. No code. | No domain registration is necessary. |
| Script tag or npm package | The viewer runs in your page. You get events and a custom UI. | Register the domain first. |
| React component | ViewerComponent for React and Next.js. | Client side only. Turn off SSR for the component. |
Facts to know before you start:
- You can load a model in three ways. Use the file ID, the name in a folder, or a tag. The tag path fits a store in which each model has the product ID as a tag.
- The page URL can set an option. A configurator state is a URL parameter, for example
?Metal=Gold. - The licence is domain-based. There is no licence key. An "Evaluation Version" watermark means that the domain is not registered. Register the domain of your client before launch.
- The viewer is isolated. It uses a Shadow DOM, so the CSS of the host page cannot break it.
- The engine core is open source. Threepipe is free, also for commercial use. WebGi is the licensed layer on top.
Start here
- Developers
- Viewer SDK introduction
- Create an embed
- Show a model by tag or name
- Register a domain for the SDK
- WebGi engine