Skip to main content

Virtual Staging API

You can generate a time stamp, or snapshot specific virtual staging domain via the Virtual Staging API.

Note that you should use the this API rather than modifying a virtual staging domain directly.

The Virtual Staging API accepts the following parameters:

  • timestamp (epoch milliseconds) or snapshotId (string)
  • Base Virtual Staging Environment (Your base VSE is setup by Amplience when your account is created and provided during the onboarding process)

Generating a VSE using a timestamp
Link copied!

To generate a VSE using a timestamp make a GET request to the Virtual Staging service in the following format:

https://virtual-staging.amplience.net/domain/<base-vse-domain
  >?timestamp=<epoch-millis></epoch-millis
></base-vse-domain>

Example:

GET
https://virtual-staging.amplience.net/domain/1vkz2i2i1hlau19hndnr03duvb.staging.bigcontent.io?timestamp=1543598417

This will return a 200 response and the body will be the newly generated API domain name you should use to request content.

Generating a VSE using a snapshotId
Link copied!

You can also use the Virtual Staging service to generate a Virtual Staging domain pinned to a content snapshot (taken from the payload of the snapshot published webhook event, for example).

To generate a VSE using a snapshotId, send a GET request to the Virtual Staging service in the following format:

https://virtual-staging.amplience.net/domain/<base-vse-domain
  >?snapshotId=<string></string
></base-vse-domain>

Example:

GET
https://virtual-staging.amplience.net/domain/1vkz2i2i1hlau19hndnr03duvb.staging.bigcontent.io?snapshotId=0cc865a52faff0001987e70

This will return a 200 response and the body will be the newly generated API domain name that you can use to request content.