Magicplan Full Version Apk

0 views
Skip to first unread message

Jarrell Campbell

unread,
Aug 5, 2024, 1:37:40 PM8/5/24
to piasandhozil
Fortesting purposes, it is recommended to create a new account. You can do this by sending the API request in the example. The EMAIL and PASSWORD parameters should be replaced by an actual email address and the desired password of the test user.

Sign in to magicplan using the test account, create a project and export it to your application using your application's export button. You can then inspect the data that has been provided by magicplan.


When the magicplan user publishes the project, magicplan will send a GET request to the receive endpoint. The request will contain the URL of the project files. The files should be downloaded within 24 hours after the GET request. An asynchronous download is recommended, i.e. after the receive request has been completed.


Before a user in magicplan can send projects to your application, their magicplan accounts need to be connected to your application. To link an account in magicplan to your application you can use this request.


For example, have the user enter his magicplan credentials in your application and use those information to call the API. magicplan validates the user and will save the ref you provided which will help you to identify the user in your application.


If your user does not have a magicplan account yet, a new magicplan account will be automatically created using the credentials provided. If you would prevent this behavior you can use the parameter onlyifexists to prevent a new magicplan account from being created.


For a user to become part of your workspace, you need to have an empty subscription seat into your workspace, which will be then assigned to your user. You can manage your subscription on the magicplan cloud, under the Billing Page. Once the user is linked to your workspace, they will also get a subscription seat assigned automatically.


Via Single Sign On: If you have all of your user accounts centralised in one place (for example Azure AD, Salesforce etc), you can reach out to magicplan's Integrations team and ask them to configure SSO for your main workspace.


Via OAuth 2.0: magicplan supports OAuth 2.0 with the Authorization Code grant. If your application supports OAuth too, you can reach out to magicplan's Integrations team and ask them to configure OAuth for your main workspace. If you want to see how OAuth works in magicplan, you can go ahead and enable Floorplanner or PlanGrid integration under API & Integrations page on the magicplan Cloud and evaluate it whether that is something you would also want to have for your integration.


To reach out to the Integrations team for configuring one of the first two options above, please send an email to integ...@magicplan.app and specify the workspace owner account or the workspace name.


Workspace API gives you access to more information about users and projects of your workspace. A detailed documentation of the response format and request parameters can be found in our SwaggerHub documentation.


For example, you may want to know or monitor the number of users that are in your workspace. To retrieve that information, you can use this request. The response is a paginated list, with a page size of 100 items.


You may want to fetch information about projects that belong to you and/or users that are part of your workspace. You can also use this request, to retrieve the ID of your workspace projects, and then fetch more detailed information for those projects.


This request provides you with a list of all projects of your workspace. The response is a paginated list, with a page size of 100 items. You can have a specific filtered and sorted result based on your needs.


This request creates an empty project with a list of attributes and dispatches it to a given user. Attributes can only be attached to the project itself (as opposed to objects inside the project) and the project does not contain any rooms initially.


To retrieve all files associated with a known project, specify the project unique identifier in the planid parameter and omit the email parameter. The planid can be obtained from magicplan when creating a new project.


When processing the project xml, you might want to download user generated images that have been attached to the project / floors / rooms / objects. You can do that, by calling listfiles service and passing filetype = picture as a parameter.


You can retrieve estimation of the project, measurement data, coordinates, notes, images, survey answers, the XML file of the project itself (in case that fits more to your needs) and lots of more information about the project.


However, you may choose to implement an additional step in which your users are able to select a specific project from your application for projects that are not already linked to a project prior to exporting that project.


If configured, magicplan uses this service to obtain a list of projects from your application and present them to your users at publishing time. magicplan then passes the project selected by the user in subsequent calls.


For example you can filter by date (only displaying the most recently accessed/created projects) or by geo-location (displaying the projects closest to where the project was made), or by a mix of the two. magicplan provides the latitude and longitude of the property, as well as its address, to help you implement a suitable filter.


You can add a placeholder labelled something like New Project at the end or the beginning of the list with an ID that you can easily recognize as not being already in your database. This would allow the user to create a new project on the fly as they published their project. On a subsequent export the newly created project will show up in the list.


If this service is configured, magicplan calls it when a user requests the right to publish a project. Once your application receives this request, you may accept or decline the transfer, based on your own account and payment information.


In case of acceptation, you must return a confirmation number that magicplan logs to allow further payment reconciliation. magicplan then calls the update webhook to notify your application that the files are ready to download. If the user updates a project that has already been paid for and published, the service is called again to verify that you are still allowing this user to publish. Your application should issue the same confirmation number and not charge the user for the update.


If the user has previously selected a project or the project has been dispatched, the project ID will be passed with the request in order to assist you in determining whether or not to accept the payment.


magicplan calls this webhook to notify your application that a user has generated new files or updated existing files. Implementing this webhook is mandatory for the "Send to [YourApplication]" button to work.


For example, let's say you have added a button somewhere in your application and called it "Capture with magicplan". You would connect the magicplan deep link to this button, so that when your user taps on the button, magicplan app will open automatically and will redirect the user straight to the project view.


magicplan can also redirect the user into your platform automatically once the user exports the project successfully into your application. For that, you would need to share your deep link (or an HTTP URL) with the magicplan's Integration Team.


The -element represents the whole floor with absolute coordinates. Walls and doors are only described once in this representation and are not grouped per room. This representation is convenient for drawing the floor when you only need a line drawing without the room nomenclature.


A list of -elements describe each room individually. Connecting walls and doors are described twice in this format, once for each room. This representation is semantically rich and allows determining in which room lies any [x, y] coordinate on the project.


The -element represents a door located on a wall in the current room. If the door is connecting two rooms, it is represented once on each wall of each room. See also SymbolInstance for more information.


The -element represents a window located on a wall in the current room. If the window is connecting two rooms, it is represented once on each wall of each room. See also SymbolInstance for more information.


Symbol Instances are the primary source for information that the user may have entered in magicplan (e.g. piece of furniture or a door). It contains a list of predefined or custom attributes that holds each value entered by the user (see Values).


Internally magicplan differentiates between wall items and pieces of furniture. Pieces of furniture (chairs, tables, kitchen sink, etc.) are placed freely inside a room while wall items (doors, windows, radiators, etc.) are always placed in relation to a wall.


The -element represents any object that has a visual representation and that can be instantiated. For example, symbols can be inserted into a room, attached to a wall or used as an item for an estimate.


A localized description of the . A description is typically longer and more detailed than a name. If no description is specified for a given language, then the English description is used. If no English description is specified, then the first description in the list is used instead.


A symbol can be of multiple types. Depending on the type, some new attributes might become available, e.g. Wall items. Depending on the context (room, floor, etc.) and the type of the symbol, some symbols might not show up in the menu.


Although a symbol can be of multiple types at once, for the best user experience there are some configurations that work best. For example, wall items (i.e. symbols with the type wall) should not be used in conjuction with other symbol types.

3a8082e126
Reply all
Reply to author
Forward
0 new messages