{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"How to start","type":"basic","slug":"how-to-start","excerpt":"The FundraisingBox provides different APIs for different purposes.","body":"[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"What do you want to do?\"\n}\n[/block]\n## Digital Fundraising use cases##\n\n**Propagate values into the FundraisingBox iFrame form**\nThe simple [Form-Prepopulation-API](doc:form-prepopulation-api) is the right choice for you.\n\n**Complex prepopulation, e.g. for shopping cart or multi step forms**\nUse our serverside [Session-API](doc:session-api-introduction) to store and validate data and submit this session to the iFrame form. \nThis API is available in Enterprise. \n\n**Create highly individual payment forms with automatic validation and payment**\nOur [Form-API](doc:form-api) provides you a mighty Javascript jQuery-Plugin for single and multi step forms. Just write your own HTML code. \nThis API is available in Enterprise. \n\n**Process payments with your server**\nThe [Payment-API](doc:payment-api) can process values directly or you submit a session.\nThis API is available in Enterprise. \n\n**Build your own charity shop**\nThe [Demo Shop with simpleCart(js)](doc:demo-shop) shows you how. \nThis API requires the product \"Charity Shop\". \n\n**Build custom Peer2Peer Fundraising themes**\nThe [FundraisingPage-JSON-API](doc:fundraising-page-json-api) provides you a JSON that you can use to build highly individual fundraising pages. \nThis API requires the product \"Peer2Peer Advanced\". \n\n##Synchronisation use case##\n\n**Access FundraisingBox objects**\nOur [REST-API](doc:rest-api) let you access your FundraisingBox objects via REST.\nThis API requires the product \"API-Package\". \n\n**Trigger synchronisation of external services**\nHave a look at our [Webhooks](doc:what-is-a-webhook) to process data automatically to your ERP, CRM or special webservice. \nThis API requires the product \"API-Package\".\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"All APIs have a daily access limit (calls per second and calls per day). \\nPlease check how many calls you have available in your FundraisingBox plan.\\n\\nWebhooks do not have any restrictions.\",\n \"title\": \"API access limits\"\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"SSL Validation\"\n}\n[/block]\nFor defeating the \"man in the middle\" you need to verify the certificate being presented to you.\nYou can do this by comparing it against Mozilla’s CA certificate bundle.\n\nBy default a curl installation (e.g. PHP curl) already uses an existing cacert.pem file.\nIf you get an error similar to „Peer’s Certificate issuer is not recognized.“ please update your cacert.pem from [https://curl.haxx.se/docs/caextract.html](https://curl.haxx.se/docs/caextract.html).\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"HTTPS\",\n \"body\": \"Always use [https://api.fundraisingbox.com](https://api.fundraisingbox.com)! If you perform a request on http you will get a redirect answer in return.\"\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Conventions in the documentation\"\n}\n[/block]\nIn the documentation that follows, the following notation is used:\n\n {text}: Indicates text that should be replaced by your own data.\n \n ...: Indicates content from the response has been elided for brevity in documentation.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"571f8856435301190079f75a","githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"General","slug":"general","order":0,"from_sync":false,"reference":false,"_id":"571f884be54f2d0e003ebb0a","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2016-04-26T15:24:59.312Z","__v":0},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"createdAt":"2016-04-26T15:25:10.700Z","user":"571f5e46d8e3cf1900762b33","__v":9,"parentDoc":null,"project":"571f5e8cd8667f0e00a3c498"}
How to start
The FundraisingBox provides different APIs for different purposes.