Links parameters
In order for users to be able to create a scan in the GoToScan app you need to provide them a link which will open the app and add a scan to do for the user.
These links contain all the necessary parameters to identify an order such as the address as well as a token to create a job on Cubicasa's end and webhook URL to keep you updated..
GoToScan link parameters
| Parameter | Required | Example value (not URL encoded) | Explanation |
|---|---|---|---|
| token | Yes | eyJpZCI6I... | A base64 url encoded string used to create the ticket after the scan is completed. Includes a signature that is checked by the app. |
| conversion_type | Yes | t3 | Defines the type of floor plan model. type t3-l1 creates a floor plan without fixed furniture. t3 creates a floor plan with fixed furniture. |
| external_id | Yes | external-ID-123.6 | Customer provided id for the scan which is used to identify the scan on the customer side. |
| webhook_url | Yes | https://url.com/listen | The webhook url that is passed to our backend and is called once processing of the scan is ready. |
| priority | Yes | one of regular, fast, ultrafast, ultrafast-12, or ultrafast-16 | Your SLA according to your contract with CubiCasa |
| suite | No | A1 | Part of the address. Optional value |
| street_address | Yes | 1 Fake Street | Customer provided street address of the property |
| city | Yes | Mountain View | Customer provided city. Part of the address |
| state | Yes | CA | Customer provided state. Part of the address |
| postcode | Yes | 94043 | Customer provided postal code. Part of the address |
| country | Yes | USA | Customer provided country. Part of the address |
| disableFeatures | No | [meshVizualisation] | An URL encoded comma delimited list of scanning features that will be disabled. See Scanning features. |
| client_name | Yes | Test Client | The value of this parameter is used in the UI to refer to the application from which GoToScan was opened. |
| staging | No | true | Will fake the upload process. Any value given to this key will cause the upload to be faked. So if you want real uploads omit this parameter all together |
Disable features
Available features to be disabled with disableFeatures parameter are:
| Feature | Supported OS | Description |
|---|---|---|
| azimuth | iOS, Android | Do not collect GPS orientation data during scanning |
| storageWarnings | iOS, Android | Hide warning if device storage is low |
| meshVisualisation | iOS | Hide scan visualization during scanning on supported devices. We recommend deactivating it due to potential issues with iOS 18. |
| backgroundResume | iOS | Do not allow users to continue scanning if the app is backgrounded |
If the OS is not supported, the feature is automatically disabled.
After setting up the correct parameters, you'll need to URL encode your GoToScan link. After encoding
you should end up a link that looks like this:
https://gotoscan.io/scan/?token=eyJpZCI6I&conversion_type=t3&external_id=external-ID-123&webhook_url=https%3A%2F%2Furl.com%2Flisten&priority=fast&suite=A1&street_address=1%20Fake%20Street&city=Mountain%20View&state=CA&postcode=94043&country=USA&client_name=Test%20Client
PLEASE NOTE: Use URL encoding for your URL attributes before distributing them to your clients – otherwise you'll have broken links
If everything is setup correctly, you can to open the link with your iOS or Android device and GoToScan app
is launched automatically. If the GoToScan app is not installed, the user is taken to a webpage that encourages
the user to download the app from App Store or Google Play Store to install it.