Deprecation warning - version 1 of the Capsule API will not be available after January 31, 2018. Developers should use version 2 when developing their applications. Developers who have already built applications please check our migration guide on how to move your applications to the latest version.

The Capsule API

The Capsule API allows developers to create applications that can retrieve or update data in your Capsule account. The API is implemented as plain XML or JSON over HTTPS using all four REST commands – GET, POST, PUT and DELETE. The API closely follows the REST principles and it’s easy to use.

Getting Started

To help you develop your ideas before you start committing time to code your project it’s useful to use a command line tool like curl to help you experiment with the API. Curl comes pre-installed on Mac OS X and most Linux distributions and can be downloaded for Windows from the curl website. If you’re downloading curl be sure to select a package with SSL support. We’ll use Curl throughout the examples in the getting started section: