REST API
Open standards & APIsAutomate Vuframe® with the REST APIs for SmartVu® and the CDN. Each API has an OpenAPI spec.
Use the Vuframe® REST APIs to read and manage Smartvus and get 3D content from your own systems: PIM, shop, CMS or scripts. Every API is described in an OpenAPI specification.
Use the Vuframe REST APIs
- Open the API reference and choose the API: Smartvu or CDN. The Aura 3D™ Pipeline APIs (Jobs, Model, Model & Pipeline) are deprecated.
- Download the OpenAPI spec of the API (for example smartvu-api.yml) and generate a client with any OpenAPI generator, or call the endpoints directly.
- Ask your project manager for API credentials. The APIs use HTTP Basic authentication.
- Test the calls with the try-it panel in the API reference before you build them into your system.
Good to know: All APIs use HTTPS and JSON. Keep your credentials on the server; never put them into front-end code. To show content on a web page, you do not need the API: use the iFrame embed.