Introduction
To perform an action using the MindMeister API, send a request (specifying a method and some parameters) to an API endpoint. A response will then be sent back to you.
- All requests take a list of named parameters.
- The required parameter
method
is used to specify the method to be called. - The required parameter
api_key
is used to specify Your API Keys. - The REST format is a simple XML-based protocol - it is a conventional HTTP GET or POST action.
- The REST endpoint URL is
http://www.mindmeister.com/services/rest/
.
Alternatively, the endpoint is available over HTTPS at
<pre>https://www.mindmeister.com/services/rest/</pre>To request the mm.test.echo service, you would invoke the following:
http://www.mindmeister.com/services/rest/?method=mm.test.echo&
api_key=123456789DEADBEEF&name=value
All responses are, by default, returned in a REST-friendly XML format. This includes a valid xml header (which is not shown in the examples):
<?xml version="1.0" encoding="UTF-8"?>
Successful Response
<rsp stat="ok"> <api_key>123456789DEADBEEF</api_key> <foo>bar</foo> <method>mm.test.echo</method> </rsp>
Failure Response
<rsp stat="fail"> <err code="112" msg="Method "mm.test.abracadarba" not found"/> </rsp>
Next, find out how to perform authentication of your MindMeister application.
Conventions
EncodingsAll strings are UTF-8 encoded.
Date and Time formatsAll times are in UTC. The format is : YYYY-MM-DD HH:MM:SS. Example: 2007-12-31 23:11:00
Importing MapsThe mm.maps.import request must be a multipart mixed post and the file content is NOT part of the needed signature. This call can not be tested via the method explorer (as it uses HTTP GET).
Exporting MapsThe mm.maps.export request returns a list of URLs for exporting the maps in different formats. Please note that if you want to export a private map you must then sign and auth the call as well to get the the maps.