{"_id":"55ef3df27c751f0d007ff82e","slug":"getting-started","type":"basic","__v":22,"category":"55eedd1b08f9423700896e69","githubsync":"","hidden":false,"link_external":false,"project":"55eedd1a08f9423700896e65","user":"55eedd0b08f9423700896e64","body":"**Welcome to Biggerplate's API documentation!**\n\nThis documentation will explain how to use the API to perform operations on behalf of a user such as download and upload mind maps, list and search mind maps and iterate over users.\n\nThe Biggerplate API uses the OAuth 2.0 framework for authentication and authorisation. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Not familiar with OAuth 2.0?\",\n  \"body\": \"If you're unfamiliar with OAuth 2.0, there's <a href=\\\"http://www.google.com/search?q=oauth+2.0\\\" target=\\\"_blank\\\">plenty of information on the web</a> to help you.\"\n}\n[/block]\nTo get started with our API, first you'll need to register an application, and to do that you need a Biggerplate account. If you don't have one yet you can [sign up here for free](https://accounts.biggerplate.com/auth/register).\n\nNext, you need to [register your application](doc:registering-your-application).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"We would love to hear about what you're planning or what you have built on top of our API, so please send us an email at **developers:::at:::biggerplate.com** and let us know what you're doing!\",\n  \"title\": \"Tell us what you're up to!\"\n}\n[/block]","createdAt":"2015-09-08T19:58:42.968Z","sync_unique":"","excerpt":"","link_url":"","order":0,"api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[]}},"title":"Overview","updates":["56027a757435de0d00fabd66"],"version":"55eedd1b08f9423700896e68","childrenPages":[]}
**Welcome to Biggerplate's API documentation!** This documentation will explain how to use the API to perform operations on behalf of a user such as download and upload mind maps, list and search mind maps and iterate over users. The Biggerplate API uses the OAuth 2.0 framework for authentication and authorisation. [block:callout] { "type": "info", "title": "Not familiar with OAuth 2.0?", "body": "If you're unfamiliar with OAuth 2.0, there's <a href=\"http://www.google.com/search?q=oauth+2.0\" target=\"_blank\">plenty of information on the web</a> to help you." } [/block] To get started with our API, first you'll need to register an application, and to do that you need a Biggerplate account. If you don't have one yet you can [sign up here for free](https://accounts.biggerplate.com/auth/register). Next, you need to [register your application](doc:registering-your-application). [block:callout] { "type": "info", "body": "We would love to hear about what you're planning or what you have built on top of our API, so please send us an email at **developers@biggerplate.com** and let us know what you're doing!", "title": "Tell us what you're up to!" } [/block]