Code

Embed API

It is possible to embed MindMeister's map editor into another web application. All map data is stored on your server and you're merely using our web-based editor for map creation. The embedded map editor can be customized to fit your Corporate Identity using custom logos and toolbar colors.

Embed our editor for maps on your server

Our map editor can be opened by third party service providers, both for editing a new map as well as existing content. In this scenario, you do not require existing user accounts on our servers. In order to open the editor window, your service will need to make a post request exemplified by the following form source code:

<form action="https://www.mindmeister.com/external/show"
target="new" method="POST" enctype="multipart/form-data"> MindMeister File: <input type="file" name="file[content]"/> Id: <input type="text" name="file[id]" value="-1"/> Name: <input type="text" name="file[name]" value="some map"/> API Key: <input type="text" name="api_key" value="your_api_key"/> Allow export: <input type="checkbox" name="file[allow_export]" /> </form>

The file you pass as content has to be in .mind, .mmap, .mm or .xmind format.

We also provide a Save button on the editor, that can be used to post the resulting map back to your service. You can provide the postback urls in the initial post request, as described in the parameter section. These urls will contain your authentication tokens as well as file identification/tokens as necessary. Our server will make a multipart post request to the specified url, containing a single parameter, the name being the name of the file and the value being the file itself. Save will be always in .mind format. Overwrite save is permited only for imported .mind files, else only save in new file is allowed.

Parameters

  • api_key - your developer api key
  • file[id] - unique integer identifier for this file
  • file[name] - file name (including the extension)
  • Note: if you provide the .mind_simple extension for your file name, then the file[content] field can contain the JSON content of the map
  • file[allow_export] - flag that enables/disables export and print functionality on the map view
  • file[view_only] - setting this flag to true will cause the map to be displayed in view only mode
  • file[hide_close_button] - setting this flag to true will hide the close button on the map view
  • file[hide_sidebar] - setting this flag to true will show the sidebar in its minimized state
  • file[use_url_params] - setting this flag to true will use the exact 'newcopy_url' or 'overwrite_url' instead of using parameters inside the post data
  • file[indexable_text] - setting this flag to true will save back a .txt file containing the indexable text of the mind map
  • file[download_url] - if you have the file stored on your server, and do not wish to post it using multipart, we will use this url to fetch and load it in the editor
  • file[content] - the file, as multipart/form-data
  • Note: if neither of the above two options are present or valid, a new map will be opened in the editor
  • file[save_action] - when the user presses the save button we will post the resulting file to one of the 2 urls described below. Parameter takes value 'o' for overwrite and 's' for save as new copy.
  • file[newcopy_url] - URL where we'll post the resulting map when the user clicks the Save button
  • file[overwrite_url] - same as above
  • file[success_url] - URL where we'll redirect the user after he clicks the Close buttons
  • external_user_name - The name of the user editing the map (first name and last name space separated)

We provide a form to try out the map editor. If you do not choose a file to upload, a new map template will be opened. The request can also take the form of a GET request, in case you do not need to pass the data as a file. For example, the following link will open a new map in our external editor:

Test editor

Want to try out the embedding API? You need to Sign In and have an API key (which is free).

Back

Gratis anmelden! Registrieren oder Google g Registrieren mit Google