The API can be used to build tools or services around Beanstalk account information. You can enable API access in your account settings. You need to be an account owner to do so.
Beanstalk uses REST methodology for its API. Our API format is XML.
Every API method requires basic HTTP authentication (digest is coming soon). You can use the login/password of any user under your account.
Beanstalk provides a Ruby gem (wrapper for ActiveResource) that will make your work with the API easier. Please let us know if you write a library in any other languages so we can post it for others. For more information about the wrapper go to the Ruby Gem page.
We’re looking for help with other language libraries. Please email us if you are interested.
Each Beanstalk model (a piece that represents some kind of data) has its own page on this site. That page contains all the information you need in order to start working with the model, including descriptions of each API method available for the model. For each API method we include two blocks of code as working examples. The first block of code illustrates how to utilize the method using the raw HTTP requests; the second block shows how to use it with the Ruby library provided by Beanstalk.
When you see code like this:
GET /api/users.xml
It means sending a GET HTTP request to a url http://accountname.beanstalkapp.com/api/users.xml.