Kivicube Docs

English

简体中文

Appearance

Self-developed H5 Plugin ​

Runtime Environment ​

Requirements

Plugin Method ​

Kivicube VersionPlugin Method
Free / Starter

Supports basic iframe embedding and Kivicube Web AR Plugin integration

  • Includes Splash screen and watermark
  • Kivicube Web AR Plugin integration: supports attributes and events, with an “Advanced API” watermark
  • Supports custom domain names (the domain name will be displayed on the watermark and authorization popup)
Pro

Supports basic iframe embedding and Kivicube Web AR Plugin integration

  • No Splash screen or watermark
  • Kivicube Web AR Plugin integration: supports attributes and events, with an “Advanced API” watermark
  • Supports custom domain names (the domain name will be displayed on the watermark and authorization popup)
Entreprise

Supports basic iframe embedding and Kivicube Web AR Plugin integration

  • No Splash screen or watermark
  • Kivicube Web AR Plugin integration: supports attributes and events, with an “Advanced API” watermark; the “Advanced API” watermark can be removed by purchasing the Web AR Plugin license
  • Supports custom domain names (the domain name will be displayed on the watermark and authorization popup; the watermark can be removed by purchasing a domain authorization product)

Quick Integration of the Web AR Plugin ​

Quick integration for Web AR Plugin

iFrame Embedding ​

  • For Basic, Personal, and Advanced users, a “Developer Trial” watermark will appear after integration.
  • Enterprise users do not have the “Developer Trial” watermark.

Scene Embedding ​

Non-enterprise users can use this method to quickly integrate a Kivicube link into their own H5 page.

If you need to use more customized features, please use the Kivicube Web AR Plugin.

html
<iframe
  src="https://www.kivicube.com/scenes/lU0kh9MnQBxa15Op5tcl3SJV53FWcSk6"
  allow="camera;"
  frameborder="0"
  width="300px"
  height="500px">
</iframe>

WARNING

The webpage using the iframe tag (the page where your self-developed H5 is located) must run on the HTTPS protocol or be accessed via http://localhost.

Otherwise, the webpage inside the iframe will fail to open the camera, and a message such as “Only supported on iOS 11 and above” will appear.

It is not recommended to perform integration testing in a development environment (such as an internal network address like 192.168.x.x), unless you have correctly configured HTTPS and can access it on your mobile device.

It is recommended to deploy directly to an online environment (which must support HTTPS access) for testing.

Collection Embedding ​

  • Non-enterprise users can use this method to quickly integrate a Kivicube link into their own H5 page.
  • If you need to use more customized features, please use the Kivicube Web AR Plugin.
html
<iframe
  src="YOURCOLLECTIONLINK"
  allow="camera;"
  frameborder="0"
  width="300px"
  height="500px">
</iframe>

WARNING

The webpage using the iframe tag (the page where your self-developed H5 is located) must run on the HTTPS protocol, or be accessed via http://localhost.

Otherwise, the webpage inside the iframe will be unable to open the camera, and a message such as “Only supported on iOS 11 and above” will appear.

It is not recommended to perform integration testing in a development environment (for example, an internal network address like 192.168.x.x) unless you have correctly configured HTTPS and can access it on your mobile device.

It is recommended to deploy directly to an online environment (which must support HTTPS access) for testing.