Conversion API's purpose is to convert Cubicasa scans produced by Cubicasa Mobile SDKs into floor plan models. Floor plans models can be Exported into floor plan images (JPG, PNG, SVG, PDF) with the help of Exporter API.Getting started#
Requesting an API key#
Conversion API is intended for advanced integration by enterprise level customers. We recommend reading our documentation to evaluate what level of integration you intent to achieve and then get in touch with our team so we can discuss your project and properly plan it with you.Environments#
There are two available different environments. You should develop and test against the QA environment and move to Production once your project is in mature state.
Currently there is a limitation that Sandbox and Production might not be identical. So as differences might exist you must test against Production environment before going live.Keep in mind that the QA environment does not send any webhooks as the tickets are not really created. Hence you can't create fix requests on QA either.How to test your integration#
Test without delivery#
You can test ticket creation without a delivery. Simply add "cctest" in the address in the payload.Test with a delivery#
You don't need to do anything, but if you send an incomplete scan (e.g. you scan your desk for five 5s) your ticket will fail our automation process and no delivery will happen.
To ensure delivery, please tell in the comment of the payload that you are testing just need a delivery.When cubicasa does not deliver a floor plan?#
Incomplete or bad scan data, including e.g. only a view of computer and desk
Scan ZIP issues or no access to source files
How to create floor plans#
Cubicasa Conversion API is meant to be used in conjunction with Cubicasa mobile SDKs available at
our developers page. Following steps are required to create floor plans
through Cubicasa SDK and Conversion API:1.
Create a scan using Cubicasa mobile SDK (iOS or Android)
2.
Upload the scan (also referred to as source in this doc) to a publicly available location (SDK produces a ZIP file that contains the scan data)
3.
Create a conversion request through POST Create Ticket containing scan address, scan URL and other required data documented in this API
4.
Listen to a webhook call for scan delivery
Errors and Support#
Modified at 2025-08-14 11:35:11
