Your integration can connect the planner to your user accounts, product catalogue, shopping cart, CRM, ERP, or other business systems. Available capabilities and access are configured with the Planner 5D team.
Server-to-server REST API
The B2B backend API returns JSON and requires authenticated requests. It supports:
Creating and authenticating users associated with your integration, verifying tokens, and updating supported profile fields. Your system maintains the mapping between its users and Planner 5D identities and requests a fresh token at the start of each user session.
Reading, creating, updating, copying, and archiving projects. Project data is available as summaries or detailed native scene JSON. A dedicated owner account can access projects created by affiliated users under the partner permissions.
Retrieving project metrics, including project, floor, and room floor areas; door and window counts by floor; and item identifiers, types, widths, depths, and heights. These values can support pricing logic, specifications, and analytics in your systems.
Accessing your catalogue and product SKU information, including available product titles, links, images, and metadata. Catalogue thumbnail assets can be used in connected product and commerce workflows.
Submitting floor-plan recognition tasks from supported image, PDF, and CAD files, including JPEG, PNG, PDF, DWG, DXF, BMP, and TIFF. Your system checks task status and retrieves the resulting editable project when complete. Optional reference dimensions can be supplied to help establish scale.
Requesting supported IFC, DWG, and DXF exports, with 2D or 3D output depending on the selected format. The partner export workflow returns message-queue connection details so your backend can receive the completed file.
Recognition and export tasks run asynchronously. CAD export availability and supported formats should be confirmed during onboarding; the partner documentation currently describes this capability as beta.
JavaScript API for the embedded editor
The B2B JavaScript API connects actions inside the embedded planner to your website or application. Your frontend loads the partner-specific JavaScript library and obtains an API instance for the planner iframe. It supports:
Listening for cart button actions and retrieving product records containing SKU, title, image, and quantity. Your implementation can send these records to a shopping cart, quote workflow, CRM, ERP, or other destination.
Reading the current project's identifier, name, links, and preview images, and listening for project-open events that identify the project and whether it has just been created.
Reading and switching between 2D and 3D views, and listening for view-mode changes made by the user.
Configuring supported editor interface elements, including the visibility and position of the bottom-right menu, and checking the authenticated user and session state.
JavaScript API access is enabled separately by the Planner 5D team. The API layers you need depend on your integration scope.
How to get started
Contact the Planner 5D team to discuss your workflow and request partner access.
During onboarding, the team provides the required configuration, credentials, and partner documentation. For an embedded integration, you will also need to provide the domains where the planner and JavaScript API will be used.
Which option should I choose?
Choose a B2B white-label integration to provide a branded planning experience with connected users, products, and business workflows.
Public API project embed links follow existing sharing and access permissions. They do not grant white-label access or authenticate visitors.