¶ Description
Restful API that provides information about the scenes and packages available for each plan as well as the ability to render an image.
¶ Get Scenes Data
¶ Parameters (GET)
- CommunityId: [String] Community Integration ID
- PlanId: [String] (Optional) Plan Integration ID
¶ Single plan data
Plan IntegrationId & Community IntegrationId to get scenes & packages data for a specific plan
URL - https://cms.alpha-vision.com/api/apiola/GetScenesData?CommunityID={ID}&PlanID={ID}
¶ API Call Example
¶ Return single plan object JSON.
¶
Community's plans data
Provide Community IntegrationID to get all scenes and packages available for all the plans within the community.
URL - https://cms.alpha-vision.com/api/apiola/GetScenesData?CommunityId={ID}
¶ API Call Example
¶ Return community plan array object JSON.
¶ Render Image
¶ Description
Render an Images of the provided scenes and product.
¶ Parameters (POST/JSON)
- SceneID: [String] ID of the scene to render.
- PackageGUID or IntegrationId: (Optional) [String] Provide PackageGUID or Package IntegrationId of the package to apply. Default product will be used for each surface defined in the package.
- Array of Surfaces: (Optional) Provide Surfaces as a list object as mentioned below. ( These will overwrite product defined in the package)
- Surface: [String] Surface Name.
- ProductGUID: Product to use on the surface.
URL: https://cms.alpha-vision.com/api/apiola/RenderImage
¶ Return
URL to image.
Example: https://api.renoworks.com/v1/project/cc672b0f-602b-4114-9ee9-b3d6d628a650/data?site=zonda&que_id=698097704&type=render
¶ API Call Example
¶ Get Scene Layers
¶ Description
Return the list of Layers that exist in the scene as well as their assigned Surface if any. Layers are defined by the artist who created the scene.
¶ Parameters (GET)
- SceneID: [String] ID of the scene.
URL : https://cms.alpha-vision.com/api/apiola/GetSceneLayers
¶ Return
An array of objects
- LayerName: The name of the layers in the scene. This cannot be changed.
- SurfaceName: The name of the surface assigned to the layer. This can be changed through the API.
¶ API Call Example
¶ Assign Surface to Layer
¶ Description
Assign custom surface name to layers of a scene.
¶ Parameters (POST/JSON)
- SceneID: [string] ID of the scene.
- SurfaceLayer: Array of layers.
- LayerName: The name of the Layer you want to assign a Surface to.
- SurfaceName: The surface name to assign to this layer. This should be the name you want to use when referencing this Layer. The same surface name can be assigned to multiple Layers, this is useful when wanting to assign the same product selection to multiple layers.
URL : https://cms.alpha-vision.com/api/apiola/AssignSurfaceToLayer
¶ Return
Same as “GetSceneLayers”. The full list of Layers and Surfaces after applying the requested changes.
¶ API Call Example
¶ Render Layer Highlight
¶ Description
Render an image of the scene that highlight the provided Layer or Surface with a red texture. Other layers will have a white texture.
¶ Paramaters (GET)
- SceneID: [string] ID of the scene.
- LayerName OR SurfaceName: Depending on the parameter provided. The Render will either use the Layers hardcoded in the scene or the Surfaces assigned to the layers to highlight a particular area of the scene.
URL: https://cms.alpha-vision.com/api/apiola/RenderSurfaceHighlight
¶ Return
URL to image.
¶ API Call Example
¶ Version History
- 0.5
- Added GetSceneLayers
- Added AssignSurfaceToLayer
- Added RenderLayerHighlight
- 0.4
- Initial Release