VRPlatformVRPlatform

Overview

The shortest path to understanding the provider integration model

Overview

VRPlatform exposes one primary provider API and one optional ingest surface.

SurfaceHostPurpose
Product APIapi.edge.vrplatform.appteam setup, app discovery, connection management, iframe session issuance, iframe product traffic
Raw ingestingest.edge.vrplatform.appdirect data submission under a separate M2M contract

Standard Provider Flow

Most providers only need these steps:

  1. get a provider API key
  2. list or create the managed team
  3. create the connection for that team
  4. if you embed VRPlatform, issue a session for each iframe user

Credentials

The external model is simple:

  • backend integration calls use a provider API key in x-api-key
  • iframe product calls use a short-lived VRPlatform bearer token
  • raw ingest, if enabled, uses an M2M token

Team Context

Provider routes come in two shapes:

  • provider-scoped routes, such as GET /teams or GET /apps
  • team-scoped routes, such as POST /connections

For team-scoped product routes, send:

x-team-id: <managed-team-id>

Provider Docs

Exact public integration docs for providers using VRPlatform

Concepts

Core terms used across the provider integration docs

On this page

OverviewStandard Provider FlowCredentialsTeam ContextRead Next