{"_id":"55eee2786af7743700e57ee6","__v":16,"version":{"_id":"55eedd1b08f9423700896e68","project":"55eedd1a08f9423700896e65","__v":11,"createdAt":"2015-09-08T13:05:31.033Z","releaseDate":"2015-09-08T13:05:31.033Z","categories":["55eedd1b08f9423700896e69","55eedf54d6e2c62b001ac0f5","55eedf63b97ce63700d0592a","55ef11c0c2c70e23001077ec","55ef1ac37c751f0d007ff7d3","55ef1ae78eb7ae0d00feeb5d","55ef1b44e7f5490d000c0e38","55ef1b552eaf2917007d6b46","55ef40ed7c751f0d007ff839","55f0391f8563861700a33771","55fb3d4aa62ba1170021aa20"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"55eedd1b08f9423700896e69","pages":["55eedd1c08f9423700896e6b","55eee2786af7743700e57ee6","55ef3df27c751f0d007ff82e","55ef619ca3a8021700a4983b"],"project":"55eedd1a08f9423700896e65","version":"55eedd1b08f9423700896e68","__v":4,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-08T13:05:31.554Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting started"},"project":"55eedd1a08f9423700896e65","user":"55eedd0b08f9423700896e64","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-08T13:28:24.954Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Before you can start using the Biggerplate API, you need to register your application with us.\n\nFollow these simple steps:\n\n1. Go to **http://accounts.biggerplate.com/applications** to register your application. You'll need to login with your Biggerplate account to do this.\n2. Click the button labelled **New Oauth Application**\n3. Enter a name for you application and click the **Generate Application** button\n4. Once generated you will be provided with a **Client ID** and a **Client Secret** which you will need later for authorisation.\n5. Enter at least one **Redirect URI** for your application then click the **Update** button\n\nOnce you have created your application, you will have the generated information listed below.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Application Parameters Explained\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Client ID\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"1-0\": \"Client Secret\",\n    \"2-0\": \"Client Name\",\n    \"3-0\": \"Redirect URI\",\n    \"0-1\": \"This is your application identifier, this value is public knowledge and will be passed with every authorisation request.\",\n    \"1-1\": \"This is your client secret, this value is used to sign a code flow request and exchange a code for an access token. This value is **PRIVATE**  and should never be given out.\",\n    \"2-1\": \"This your application name that will be presented to the user during an authorisation flow.\",\n    \"3-1\": \"Redirect URI's are whitelisted endpoints that your application is listening on, such as `https://myapp.com/`, this means that we will allow the user to complete the flow only if it originated from that source.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\nOnce you have registered your application, you will use your credentials in order to start an *authorisation flow*. The *authorisation flow* is as a term used to describe a user authenticating your application access to perform operations using their account.\n\nFind out about Authorisation on our [Authorisation](doc:authorization-flow) page.\n\n\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Notice\",\n  \"body\": \"If you are not familiar with OAuth 2.0, please visit our [OAuth 2.0](/oauth2) section.\"\n}\n[/block]","excerpt":"Create your application and provide information","slug":"registering-your-application","type":"basic","title":"Registering your Application"}

Registering your Application

Create your application and provide information

Before you can start using the Biggerplate API, you need to register your application with us. Follow these simple steps: 1. Go to **http://accounts.biggerplate.com/applications** to register your application. You'll need to login with your Biggerplate account to do this. 2. Click the button labelled **New Oauth Application** 3. Enter a name for you application and click the **Generate Application** button 4. Once generated you will be provided with a **Client ID** and a **Client Secret** which you will need later for authorisation. 5. Enter at least one **Redirect URI** for your application then click the **Update** button Once you have created your application, you will have the generated information listed below. [block:api-header] { "type": "basic", "title": "Application Parameters Explained" } [/block] [block:parameters] { "data": { "0-0": "Client ID", "h-0": "Parameter", "h-1": "Description", "1-0": "Client Secret", "2-0": "Client Name", "3-0": "Redirect URI", "0-1": "This is your application identifier, this value is public knowledge and will be passed with every authorisation request.", "1-1": "This is your client secret, this value is used to sign a code flow request and exchange a code for an access token. This value is **PRIVATE** and should never be given out.", "2-1": "This your application name that will be presented to the user during an authorisation flow.", "3-1": "Redirect URI's are whitelisted endpoints that your application is listening on, such as `https://myapp.com/`, this means that we will allow the user to complete the flow only if it originated from that source." }, "cols": 2, "rows": 4 } [/block] Once you have registered your application, you will use your credentials in order to start an *authorisation flow*. The *authorisation flow* is as a term used to describe a user authenticating your application access to perform operations using their account. Find out about Authorisation on our [Authorisation](doc:authorization-flow) page. [block:callout] { "type": "info", "title": "Notice", "body": "If you are not familiar with OAuth 2.0, please visit our [OAuth 2.0](/oauth2) section." } [/block]