Deep Linking
Deep linking allows users to navigate directly from other apps to the magicplan app.
Open a Project
magicplanstd://project/{projectId}
This URL will automatically open the magicplan app and open the project identified by the given projectId .
If the project has not been downloaded yet to the app and an internet connection is available, it will download and open the project automatically.
Example Usage
If your application uses the Create a new project REST API to create a magicplan project directly for your user, you can send your user a notification email with the deep link to automatically download and open the project.
Create a Project
magicplanstd://create-project?name=My New Project&external_reference_id=ERP12345
In addition to the Create a new project REST API that is used to create a magicplan project from server to server, you can also create a project locally from app-to-app.
| Parameter | Description | Mandatory | Data Type |
|---|---|---|---|
| name | The Project Name | Yes | String |
| target_workgroup_id | Specify the workspace or team where the project will be defined. | No | String |
| external_reference_id | The identifier of your local project that has been assigned to the magicplan project.This is used to link customer project and magicplan projects. | No | String |
| address_1 | Address: Street | No | String |
| city | Address: City | No | String |
| zip | Address: ZIP Code | No | String |
| country | Country | No | String |
| longitude | GPS Coordinate | No | Float |
| latitude | GPS Coordinate | No | Float |
