{"_id":"564a3eb1e2efd717002afd96","project":"561f8ca44d67490d00804ae5","slug":"introduction","__v":26,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"rebuildingsociety.com API\"\n}\n[/block]\n**Service Specification v1.2.1**\nDiff. with v0.1 – change api methods description\nDiff. with v0.2 – clarification on the functioning of various methods\nDiff. with v0.3 – addition and definition of methods 3.9 – 3.13\nDiff. with v0.4 – done methods 3.1-3.8, add question to 3.4\nDiff. with v0.5 – done methods 3.9-3.10\nDiff. with v0.6 – done methods 3.11-3.13 . add suggestion to method 3.11\nDiff. with v0.9 – updated description of 3.9, 3.10, 3.11\nDiff. with v1.0 – added method 3.14\nDiff. with v1.01 – method 3.11 update\nDiff. with v1.11 – added method 3.16\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"​ About this API\"\n}\n[/block]\nThe rebuildingsociety.com API can easily integrate with client-side web and mobile applications and be used to query and (for existing users) invest in loans and microloans.\n\n- The Service is a collection of methods that accepts HTTPS requests and responds over HTTPS. \n- The Service uses secure cookie access authentication\n- All parameters and values accepts any mix of lower or upper case characters. \n- The Service accepts API Name's in lower and uppercase. \n- The Service returns responses in JSON format. \n- If no data is found for the customer’s request then only the header metadata is returned.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Be inspired with these great integration examples...\"\n}\n[/block]\nSee examples of what people have achieved with our API:\n\nhttp://www.investup.co - Market Comparison & 3rd party account management. Our users can use InvestUp to manage multiple accounts including rebuildingsociety.com and many others.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Lenders - Get your user API key here\"\n}\n[/block]\nIf you are a rebuildingsociety.com user, looking for <a href=\"https://www.rebuildingsociety.com/partners/get-api-key/\">your API key to use with a third party application, you can find it here.</a>\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Register your application to stay up to date with API changes\"\n}\n[/block]\nTo best support you, we need to know about your app and how you intend to use the API. <a href=\"https://www.rebuildingsociety.com/introducers/resources/api-user-survey/\">Please take 5 minutes to complete our short survey.</a> Once approved we'll grant your key.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Where to find bindings?\"\n}\n[/block]\nYou can get bindings from our github repository https://github.com/rebuildingsociety\n\nWe offer bindings for the following languages:\n- c# (coming soon)\n- PHP\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Get Involved...\"\n}\n[/block]\nSee what we're developing, get support and request new features on our project collaboration portal: https://projects.web-translations.co.uk/projects/249","category":"561f8ca54d67490d00804ae9","parentDoc":null,"user":"5649fb28e2efd717002afcf4","excerpt":"The rebuildingsociety.com API can easily integrate with client-side web and mobile applications and be used to query and (for existing users) invest in loans and microloans.","githubsync":"","hidden":false,"order":0,"type":"basic","link_external":false,"link_url":"","updates":[],"version":"561f8ca44d67490d00804ae8","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"createdAt":"2015-11-16T20:38:09.764Z","sync_unique":"","title":"Getting Started","isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

Getting Started

The rebuildingsociety.com API can easily integrate with client-side web and mobile applications and be used to query and (for existing users) invest in loans and microloans.

[block:api-header] { "type": "basic", "title": "rebuildingsociety.com API" } [/block] **Service Specification v1.2.1** Diff. with v0.1 – change api methods description Diff. with v0.2 – clarification on the functioning of various methods Diff. with v0.3 – addition and definition of methods 3.9 – 3.13 Diff. with v0.4 – done methods 3.1-3.8, add question to 3.4 Diff. with v0.5 – done methods 3.9-3.10 Diff. with v0.6 – done methods 3.11-3.13 . add suggestion to method 3.11 Diff. with v0.9 – updated description of 3.9, 3.10, 3.11 Diff. with v1.0 – added method 3.14 Diff. with v1.01 – method 3.11 update Diff. with v1.11 – added method 3.16 [block:api-header] { "type": "basic", "title": "​ About this API" } [/block] The rebuildingsociety.com API can easily integrate with client-side web and mobile applications and be used to query and (for existing users) invest in loans and microloans. - The Service is a collection of methods that accepts HTTPS requests and responds over HTTPS. - The Service uses secure cookie access authentication - All parameters and values accepts any mix of lower or upper case characters. - The Service accepts API Name's in lower and uppercase. - The Service returns responses in JSON format. - If no data is found for the customer’s request then only the header metadata is returned. [block:api-header] { "type": "basic", "title": "Be inspired with these great integration examples..." } [/block] See examples of what people have achieved with our API: http://www.investup.co - Market Comparison & 3rd party account management. Our users can use InvestUp to manage multiple accounts including rebuildingsociety.com and many others. [block:api-header] { "type": "basic", "title": "Lenders - Get your user API key here" } [/block] If you are a rebuildingsociety.com user, looking for <a href="https://www.rebuildingsociety.com/partners/get-api-key/">your API key to use with a third party application, you can find it here.</a> [block:api-header] { "type": "basic", "title": "Register your application to stay up to date with API changes" } [/block] To best support you, we need to know about your app and how you intend to use the API. <a href="https://www.rebuildingsociety.com/introducers/resources/api-user-survey/">Please take 5 minutes to complete our short survey.</a> Once approved we'll grant your key. [block:api-header] { "type": "basic", "title": "Where to find bindings?" } [/block] You can get bindings from our github repository https://github.com/rebuildingsociety We offer bindings for the following languages: - c# (coming soon) - PHP [block:api-header] { "type": "basic", "title": "Get Involved..." } [/block] See what we're developing, get support and request new features on our project collaboration portal: https://projects.web-translations.co.uk/projects/249