This quickstart is part of magicplan's developer portal, that allows you to quickly evaluate the magicplan API. You can sign up in the magicplan Cloud, generate an API-Key/Customer Key and use it to dispatch and retrieve plans from the magicplan app. The quickstart will show the XML of the floor plan.

Step 1 of 4 Setup

In this step, you connect to your magicplan account via the API.

  1. You need a magicplan account. Register yourself in the cloud, if you have not done so already.
  2. Go to Workspace settings and generate your API Key and the Customer Key.
  3. Enter the values that you see on the Export Settings section.

For more information, please see the chapter Getting Started from magicplan’s integration guide.

Step 2 of 4 Dispatch

In this step, you create a new empty plan in the magicplan cloud for your user.

  1. Enter the name of the new floor plan.
  2. Click the button "Dispatch plan to magicplan cloud".
  3. Open the magicplan app on your iPad or iPhone.
  4. Login into your magicplan account and enable the cloud symbol to show floor plans in the cloud. You may have to refresh the list of plans by dragging downwards. It may take a few seconds for the new plan to appear.

Step 3 of 4 Receive

In this step, you add rooms to the floor plan and export it via the API.

  1. Open the floor plan in the magicplan app and add a few rooms.
  2. Go to the export screen in the magicplan app and click on the export button (the customized button of your workgroup). If you didn't configure your workgroup export button yet, please follow the steps here.
  3. After the export has finished, click the button "Receive plan from magicplan" on this website.
  4. You will see the plan’s XML below.

Step 4 of 4 Inspect