Overview
Planner 5D B2B is delivered as a white-label platform that embeds into your website or application. The integration is API-driven – your team controls how users authenticate, how the planner connects to your systems, and how project data flows in and out.
The API has two layers that work together: a JavaScript API for frontend interaction and a server-to-server REST API for backend operations. Both are required for a full integration. Access to both is provisioned after signing.
JavaScript API
Handles all interaction between your frontend and the embedded planner. Once the iframe is in place, the JavaScript API gives your team programmatic access to what's happening inside the editor.
Available capabilities:
Embed the planner as a full iframe within your page
Initialise and manage user sessions
Listen for cart button events — triggered when a user clicks the action button inside the editor
Retrieve the current product list from an active session — returns item-level data for downstream processing
Read and set the current editor view mode (2D or 3D)
Listen for project open events
Configure editor UI elements
The cart listener and product list retrieval are the primary integration points for commerce and CRM connections. The action button inside the editor is fully configurable — what it does and where it sends data is controlled entirely by your implementation.
Server-to-server REST API
Handles backend operations independently of the frontend session. All responses are JSON. Authentication is required for all requests.
Available capability areas:
User management Create, authenticate, and update users. Session tokens are generated per user session and are not persistent — your system requests a new token at the start of each session. Users are linked to your own user identifiers via a mapping stored in your database.
Project operations Read, create, update, copy, and archive projects. Project data is accessible at summary and detailed levels. A metrics endpoint provides room-level dimensional data — floor area, item counts, item dimensions — useful for pricing logic or analytics built on top of the planner.
Catalogue access Retrieve your partner catalogue including item metadata, SKU data, and thumbnail assets. The catalogue is managed within your Planner 5D environment.
AI floor plan recognition Submit an image or CAD file and receive a structured, editable 3D project in return. Accepted formats include common image formats (JPEG, PNG, PDF) and CAD formats (DWG, DXF). Recognition tasks are submitted asynchronously — your system polls for status and retrieves the result when complete. This capability is usage-based and priced separately.
CAD export Export completed projects to IFC, DWG, or DXF format. Export tasks are processed asynchronously via a message queue. Currently in beta.
Integration structure
A standard integration follows four phases. Full implementation detail is provided in the API documentation available after signing.
Credentials and environment setup Your team receives an API key and application name. You provide the domains on which the JavaScript API and iframe will be used — this is a security requirement. Configuration is completed on the Planner 5D side before integration work begins.
Iframe embed and user authentication The planner is embedded via iframe. Users are authenticated through your own system — no separate Planner 5D account or login is required on the user side. Your backend generates a session token per user via the REST API and passes it to the frontend for session initialisation.
System connection The cart listener is configured to push the product payload to your chosen endpoint — shopping cart, CRM, ERP, order management system, or any custom destination. The payload contains item-level data for each product in the active session.
Catalogue setup and go-live Your product catalogue is loaded into your Planner 5D environment. Integration is tested and QA'd before go-live. The platform scales to your full user base without per-user licensing implications.
Additional capabilities
The following are available within the platform or via API and can be discussed as part of your integration scope:
Photorealistic 4K renders — usage-based, triggerable as part of a project or proposal workflow
360° walkthrough and panoramic views — available as an add-on within the embedded experience
AI room designer — auto-furnishes a space from your product catalogue using AI, available as a configurable add-on
Project metrics — room dimensions, floor area, item counts and dimensions accessible via REST API
UTM parameter forwarding — pass UTM parameters through the embed for conversion tracking
Pricing feed integration — sync product pricing from a CSV/XML feed or API connection, updated on a scheduled basis
Dedicated technical support channel — direct access to the Planner 5D technical team, available as part of the contract