What Is Kivicube?

Kivicube is a platform focused on AR content creation and distribution. You can build scenes on the platform, organize them into collections, and publish them to the Web, Mini Programs, and other channels.

For developers, Kivicube provides value on two levels:

• Content production: build scenes, upload assets, configure interactions, and publish everything inside the Kivicube platform.
• Integration: embed published scenes or collections into your own website, H5 page, or campaign page, and customize certain UI and runtime behaviors on the Web.

What This Documentation Helps You Solve

This documentation focuses on the second part: Web integration and secondary development. Here you will learn:

• how to quickly embed a scene or collection with an iframe
• how to open, close, and listen for events through iframe-plugin.js
• how to customize UI elements on the host page, such as landing pages, loading states, scanning states, and photo buttons
• how to use advanced APIs to inspect objects and control videos, animation, lighting, and cameras

Platform Overview

Authoring

You can visit https://cloud.kivicube.com on a PC or tablet, register an account, create scenes, upload assets, configure interactions, and publish accessible scenes or collections.

For platform-side authoring instructions, see the Manual.

Delivery

After publishing, the platform provides either a Web experience URL or a QR code. For integration work, the most important identifiers are:

• sceneId: a 32-character scene ID
• collectionId: a 6-character collection ID

You can either use the officially hosted experience page directly, or embed it into your own site.

Officially Hosted Pages

Web scene URLs usually look like this:

https://www.kivicube.com/scenes/<sceneId>

Collection URLs usually look like this:

https://www.kivicube.com/collections/<collectionId>

Integrate with Your Own Website

Continue to the next page: Quick Start.