Planning Center API
API Details
This is just the starting point, we will also be enabling access to songs & plans in the near future, but before we did that we wanted to make sure that the API would meet your needs. If you have any questions please e-mail support@planningcenteronline.com.
Also, as a beta release this API might change at anytime. But please be rest assured that any changes will only be the additions of attributes or elements.
Also, as a beta release this API might change at anytime. But please be rest assured that any changes will only be the additions of attributes or elements.
Overview
We have created this API for our customers so that they can access and manipulate their data in an easy and flexible way. This api is built on top of a very simple REST technique (XML over HTTP using all four verbes GET/POST/PUT/DELETE).
When you're creating and updating resources, you'll be sending XML into Planning Center Online. You need to let the system know that fact by adding the header "Content-type: application/xml", so we know that it's not regular form-encoded data coming in. Then you just include the XML of the resource in the body of your request.
When you're creating and updating resources, you'll be sending XML into Planning Center Online. You need to let the system know that fact by adding the header "Content-type: application/xml", so we know that it's not regular form-encoded data coming in. Then you just include the XML of the resource in the body of your request.
Authentication
The API is accessed through your normal Planning Center account. No special API account is needed to access the API but you might want to create an API person so that you can see all of the updates done through the API.
We use OAuth 1.0a for authentication against our servers. To request a Consumer Key please e-mail support@planningcenteronline.com with your product name, description, company name and contact information.
We use OAuth 1.0a for authentication against our servers. To request a Consumer Key please e-mail support@planningcenteronline.com with your product name, description, company name and contact information.
Ruby
Our API is completely compatible with ActiveResource which you can find more information about here. But you will need to tweak it to support OAuth, you can find a plugin to do this at http://github.com/jwagener/oauth-active-resource.
PHP
Getting OAuth going with php can be tricky. We've provided a php example application to get you started.
Other Languages
We highly recommend jQuery and it's $.ajax function for connecting to our api, but any language that speaks http will be able to connect. If you have questions about your programming language of choice please e-mail support@planningcenteronline.com.
