Skip to content
ZOVRYX

Developers

Build on ZOVRYX.

We're designing APIs and an SDK so you can embed experiences, sync content and control access from your own systems. Here's the plan — nothing below is live yet.

API concept

Three ways in.

A REST API for content and access, an embed for websites, and a typed SDK for apps.

rest-api.httpIllustrative — API in development
# Concept only — no public endpoints exist yet.
GET  /v1/experiences/{id}
GET  /v1/experiences/{id}/scenes
POST /v1/entitlements      # grant access to a visitor
embed.htmlIllustrative — API in development
<!-- Concept only — script not published -->
<script src="[cdn.zovryx.com/embed.js]" async></script>
<zovryx-experience
  experience="rome-colosseum"
  mode="explore">
</zovryx-experience>
app.tsIllustrative — API in development
import { Zovryx } from "@zovryx/sdk"; // not yet published

const zx = new Zovryx({ apiKey: process.env.ZOVRYX_KEY });

const scene = await zx.scenes.get("colosseum-arena");
zx.on("hotspot.opened", (e) => console.log(e.hotspotId));

Planned platform

What you'll be able to build with.

  • API keysPlanned

    Scoped keys per project and environment, with rotation.

  • WebhooksPlanned

    Events for publication, redemptions and visitor progress.

  • Scene embeddingPlanned

    Drop a scene into any web page with a single element.

  • Asset pipelinePlanned

    Upload glTF, USDZ, audio and video; we validate and optimise.

  • Entitlement modelPlanned

    Grant, check and revoke access per visitor, ticket or pass.

Quickstart

Getting started, when it opens.

  1. 1Request developer preview access.
  2. 2Create a project and an API key in Studio.
  3. 3Embed a published experience or call the API.
  4. 4Listen for webhooks to sync access and progress.

Resources

  • API referenceComing with the preview
  • Sample projectsComing with the preview
  • GitHub[Repository URL TBC]
  • Developer community[Channel TBC]

Building something bigger?

Talk to us about integrations for your platform.