Features Tour
API Details
This is a beta release of the Planning Center API. 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.
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). We actually tried to mimmick the API from 37 Signals Highrise to make for easier integration.
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.
To gain access to the API you will need to get your API Key. You can do this by logging in as the user you want to access the API and click "my account" and then "generate api key". That api key will be for that user and when connecting to the api you will only be able to do things that user can do. To use the api the user must have the permissions of 'editor' or above.
Since we are using HTTP Basic Authentication, when connecting to the API all you will need to do is provide your API Key as your username and then provide a dummy password (we use X).
To gain access to the API you will need to get your API Key. You can do this by logging in as the user you want to access the API and click "my account" and then "generate api key". That api key will be for that user and when connecting to the api you will only be able to do things that user can do. To use the api the user must have the permissions of 'editor' or above.
Since we are using HTTP Basic Authentication, when connecting to the API all you will need to do is provide your API Key as your username and then provide a dummy password (we use X).
http://APIKEY:X@www.planningcenteronline.com/people.xml curl -u APIKEY:X http://www.planningcenteronline.com/people.xml Replace APIKEY with the API Key from your "My Account" page.
Active Resouce for Ruby
Our API is completly compatible with ActiveResource which you can find more information about here.