Meta tags:
description= Introduction Most companies that want to integrate Floorplanner into their website or mobile app, want to embed the editor and be able to export 2D & 3D floorplan images. This page walks you through the steps necessary to make that happen. Please note that this guide is limited to the new HTML5 ...;
Headings (most frequently used words):
getting, started, fml, export, floorplanner, embedding, oauth, api, mobile, marketplace, services, media, suppliers, introduction, sandbox, vs, production, create, new, project, request, token, embed, the, editor, 2d, 3d, floorplan, images,
Text of the page (most frequently used words):
post (69), get (68), the (32), list (29), project (28), #create (23), user (23), you (21), api (21), del (21), show (20), update (18), remove (16), export (15), and (15), this (12), order (12), editor (11), search (11), floor (10), room (10), type (10), token (9), new (9), design (9), styleboard (9), fml (8), can (8), that (8), your (8), permission (8), projects (7), for (7), product (7), sandbox (6), production (6), set (6), page (6), floorplanner (6), getting (6), started (6), sponsorship (6), role (6), embed (5), request (5), introduction (5), need (5), have (5), embedding (5), from (5), labels (5), template (5), camera (5), drawing (5), floorplan (4), images (4), url (4), want (4), please (4), are (4), section (4), use (4), how (4), authentication (4), later (4), add (4), services (4), viewer (4), products (4), permissions (4), removed (4), data (3), when (3), which (3), result (3), with (3), make (3), mobile (3), copy (3), reject (3), accept (3), destroy (3), delete (3), productgroup (3), document (3), service (3), object (3), invite (3), lead (3), leads (3), exports (3), company (3), profile (3), generate (3), users (3), measurements (3), recover (3), reference (3), updated (2), about (2), years (2), ago (2), most (2), companies (2), able (2), their (2), example (2), via (2), note (2), first (2), variant (2), levels (2), also (2), possible (2), single (2), method (2), describes (2), them (2), remember (2), returned (2), because (2), explains (2), https (2), different (2), sure (2), details (2), branding (2), ids (2), key (2), environment (2), account (2), through (2), listing (2), connect (2), group (2), groups (2), roomtypes (2), another (2), duplicate (2), label (2), json (2), based (2), link (2), sub (2), designs (2), cameras (2), floors (2), download (2), import (2), jump (2), log (2), table, contents, project_id, won, but, some, done, simply, adding, all, floorplans, only, exported, image, customize, needs, look, settings, wall, top, colors, furniture, items, collections, load, sets, once, detail, private, default, meaning, access, unless, logged, owner, since, our, stateless, tokens, give, way, its, requests, before, represents, household, free, standing, house, multiple, level, apartment, using, com, dev, run, domains, right, one, alternatively, sending, email, will, likely, stage, uses, http, basic, should, scheme, support, testing, called, both, environments, view, visiting, enterprise, partner, admin, allows, manage, keys, addition, providing, information, such, may, required, point, integrate, into, website, app, walks, steps, necessary, happen, guide, limited, html5, powered, connected, listings, address, offices, media, suppliers, execute, wescan, matterport, vloor, available, marketplace, specification, android, ios, revoke, authorize, oauth, roomplanner, spaceplanner, current, roomtypesets, productviewer, documents, styleboards, popular, action, analytics, reports, disconnect, subusers, assigned, sponsorships, csv, assigns, unassigns, templates, panorama, roles, become, put, floorscanner, deeplink, enable, tour, unpublish, publishes, textures, undestroy, share, mail, xml, legacy, upgrade, last, deleted, apple, roomplan, content,
Text of the page (random words):
getting started jump to content api reference v2 0 log in api reference log in v2 0 api reference getting started jump to getting started getting started authentication floorplanner project list projects get create project post search projects get import project post import apple roomplan post list 25 last deleted projects post show project get update project post destroy delete project del upgrade project post duplicate a project post copy a project to another user post generate project based token get list products get download fml xml legacy get download fml json get generate share link and e mail post undestroy recover project post list textures get publishes a project post unpublish a project del enable 3d tour exports for a project del list project labels get show data from the lead get project measurements get create floorscanner deeplink post project permissions list permissions get add a new permission post show permission get update a permission post remove a permission del floor list floors get create a floor post list removed floors get recover a removed floor post show floor get update floor post remove a floor del floor measurements get floor drawing show drawing data get create drawing post update drawing put remove a drawing del floor camera list cameras get create camera post update order for cameras post show camera get update a camera post remove a camera del design list designs get create a design post list removed designs get recover a removed design post show design get update design post remove a design del design measurements get user list users get create a sub user post search users get invite a users to become a sub user post invite a user by a link get show user get update user post remove a user del generate user based token get list user labels get user profile show user s profile get update profile post user company show company get update company post user role list roles get create a new role post show role get update a role post remove a role del remove a role from a user post export list exports get show export get list export labels get search exports get export a project post export a panorama post template list templates get create a template post show template get update template post remove a template del leads search leads get assigns and unassigns a user from a lead post export leads as csv as json get remove a lead del sponsorship list sponsorships get create a sponsorship post show sponsorship get update a sponsorship post remove a sponsorship del create a sponsorship through an invite post label list labels by object get add labels to an object post remove a label from an object del service list services get list subusers with assigned services get connect a user to a service post disconnect a user from a service del reports product analytics get popular products by action get styleboard list and search styleboards get create styleboard post show styleboard get update styleboard post destroy delete styleboard del duplicate a styleboard post copy a styleboard to another user post styleboard permissions list permissions get add a new styleboard permission post show permission get update a permission post remove a permission del document list and search documents get create document post remove document del productviewer search products get roomtypesets search room type set get create a room type set post show room type set get update room type set post remove room type set del roomtypes list roomtypes get create a room type post show room type get update room type post remove room type del products show product get productgroup list and search current user s product groups get create productgroup post list and search account user s product groups get show product group get update productgroup post destroy delete product group del embedding embedding the editor viewer spaceplanner roomplanner embedding the product viewer oauth api introduction authorize get token post revoke token post mobile viewer for ios viewer for android fml v3 0 specification marketplace services introduction available services vloor create order post order result get accept order post reject order post matterport create order post accept order post reject order post wescan mobile create order post execute order post accept order post reject order post media suppliers introduction api list offices get search listings by address get add listing post connect project post list projects connected with a listing get powered by getting started getting started copy page introduction most companies that want to integrate floorplanner into their website or mobile app want to embed the editor and be able to export 2d 3d floorplan images this page walks you through the steps necessary to make that happen please note that this guide is limited to the new html5 editor and the new api v2 sandbox vs production we have a testing environment called sandbox and a production environment for both environments you need to have a different api key you can view your api details by visiting the api page production api page sandbox on your enterprise or partner admin account this page allows you to manage your api keys in addition to providing information such as your user and branding ids which may be required at a later point alternatively you can request your details by sending an email to floorplanner support make sure you also request your user and branding ids as you will likely need them at a later stage the floorplanner api uses http basic authentication and this section explains how you should use your api key in this authentication scheme the sandbox api and the production api run on different domains make sure you use the right one sandbox url https floorplanner dev api v2 production url https floorplanner com api v2 create new project before you can embed the editor you first have to create a new project a project represents a household a free standing house with multiple levels or a single level apartment this section explains how to create a new project using the api please remember the project id that is returned in the result because you need it later when embedding the editor request token projects are private by default meaning that you can t access them unless you are logged in and are the owner since our api is stateless we use tokens to give the editor a way to authentication its requests this section describes how you can request a token please remember the token id that is returned in the result because you need it later when embedding the editor embed the editor once you have a project id and a token you can embed the editor this page describes in detail how to do that if you want to customize the editor to your needs have a look at the settings section it s possible for example to set the wall top colors in 2d 3d which furniture items collections to load or which room type sets to use export 2d 3d floorplan images you can export all the floorplans of a project as 2d or 3d images via this api method please note that when you export a project only the first design variant of the floor levels are exported it s also possible to export a single floorplan design variant as a 2d or 3d image via this api method export fml most companies won t need this but some want to be able to export their projects as fml data this can be done simply adding fml to the url for example url projects project_id fml updated about 2 years ago updated about 2 years ago table of contents introduction sandbox vs production create new project request token embed the editor export 2d 3d floorplan images export fml
|