Reliefs Docs
3D Visualisation SDK

Prerequisites

What you need before integrating the Reliefs SDK, on any platform.

Every platform (Web, React, iOS, Android, Flutter) needs the same two things before you start:

  1. A public SDK API key (pk_) — generated from your Reliefs dashboard under Organization → SDK & API keys.
  2. A product UUID — shown on the product page in the dashboard, for each product you want to display.

Authorize your origin / app ID

A pk_ key only works from origins (web) or app IDs (mobile) you've added to its allowlist in the dashboard. An un-allowlisted caller gets ORIGIN_NOT_ALLOWED / APP_ID_NOT_ALLOWED. This exchange happens automatically inside the SDK — you never call it yourself.

Every integration follows the same three steps: add the SDK, initialize it once with your public key, then render a viewer for a product. Pick your platform:

  • Web<script> include
  • React@v1/reliefs-react package
  • iOS — Swift package
  • Android — Gradle dependency
  • Flutterreliefs_sdk pub package