Reference
Versioning
What stays stable, and how we retire something.
What is covered
- The iframe addresses and their URL options.
- The messages between your page and the viewer.
- The SDK: the
@vskin/sdkpackage andembed.js. - The error codes and their families.
Compatibility
What you have set up keeps working: an option, command, event or code never changes meaning. New ones may appear at any time. Improvements to the rendering and to the look of the HUD are not breaking changes.
Deprecations
To remove something, we deprecate it first: it keeps working, the docs mark it, and we tell you directly. It goes away 12 months later at the earliest, and never before the end of a yearly plan paid before the announcement.
Major versions
A breaking change ships as a new major version, with its own addresses (/v2) and SDK (2.x). The previous one stays online for 12 months after the new one ships, and never less than the end of a yearly plan paid before then.
embed.js addresses
What the render service serves right now: