{"_id":"571f8856435301190079f75a","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"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.","githubsync":"","order":0,"type":"basic","updates":[],"category":"571f884be54f2d0e003ebb0a","excerpt":"The FundraisingBox provides different APIs for different purposes.","link_external":false,"version":"571f5e8cd8667f0e00a3c49b","createdAt":"2016-04-26T15:25:10.700Z","isReference":false,"sync_unique":"","user":"571f5e46d8e3cf1900762b33","__v":9,"hidden":false,"link_url":"","parentDoc":null,"project":"571f5e8cd8667f0e00a3c498","slug":"how-to-start","title":"How to start","next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

How to start

The FundraisingBox provides different APIs for different purposes.

[block:api-header] { "type": "basic", "title": "What do you want to do?" } [/block] ## Digital Fundraising use cases## **Propagate values into the FundraisingBox iFrame form** The simple [Form-Prepopulation-API](doc:form-prepopulation-api) is the right choice for you. **Complex prepopulation, e.g. for shopping cart or multi step forms** Use our serverside [Session-API](doc:session-api-introduction) to store and validate data and submit this session to the iFrame form. This API is available in Enterprise. **Create highly individual payment forms with automatic validation and payment** Our [Form-API](doc:form-api) provides you a mighty Javascript jQuery-Plugin for single and multi step forms. Just write your own HTML code. This API is available in Enterprise. **Process payments with your server** The [Payment-API](doc:payment-api) can process values directly or you submit a session. This API is available in Enterprise. **Build your own charity shop** The [Demo Shop with simpleCart(js)](doc:demo-shop) shows you how. This API requires the product "Charity Shop". **Build custom Peer2Peer Fundraising themes** The [FundraisingPage-JSON-API](doc:fundraising-page-json-api) provides you a JSON that you can use to build highly individual fundraising pages. This API requires the product "Peer2Peer Advanced". ##Synchronisation use case## **Access FundraisingBox objects** Our [REST-API](doc:rest-api) let you access your FundraisingBox objects via REST. This API requires the product "API-Package". **Trigger synchronisation of external services** Have a look at our [Webhooks](doc:what-is-a-webhook) to process data automatically to your ERP, CRM or special webservice. This API requires the product "API-Package". [block:callout] { "type": "info", "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.", "title": "API access limits" } [/block] [block:api-header] { "type": "basic", "title": "SSL Validation" } [/block] For defeating the "man in the middle" you need to verify the certificate being presented to you. You can do this by comparing it against Mozilla’s CA certificate bundle. By default a curl installation (e.g. PHP curl) already uses an existing cacert.pem file. If 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). [block:callout] { "type": "warning", "title": "HTTPS", "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." } [/block] [block:api-header] { "type": "basic", "title": "Conventions in the documentation" } [/block] In the documentation that follows, the following notation is used: {text}: Indicates text that should be replaced by your own data. ...: Indicates content from the response has been elided for brevity in documentation.