Concepts
Core terms used across the provider integration docs
Concepts
| Term | Meaning |
|---|---|
| Provider | The external integration identity in VRPlatform. Example: Hostaway. |
| Provider API key | The backend credential your integration uses on the product API. |
| Managed team | The VRPlatform team your integration is operating on. |
x-team-id | Header used on team-scoped product routes to select the managed team. |
| Embedded user | The user inside your product who will use the VRPlatform iframe. |
sub | Your stable external user id for that embedded user. |
| Session token | The short-lived VRPlatform bearer token returned by POST /auth/embed/session. |
| Raw ingest | An optional backend-only data submission surface using M2M auth. |
sub
sub must be stable for the lifetime of the user.
Good values:
- immutable external user id
- provider-side account id
Avoid values that can change over time.
Managed Team
A managed team is the main unit you work with on the product API.
Typical managed-team actions:
- create a connection
- inspect team issues
- issue iframe sessions into that team
Session Token
The session token is only for the embedded frontend.
Use it on product API calls from the iframe:
Authorization: Bearer <accessToken>