This documentation site is deprecated. The latest up-to-date API reference is available at https://reference.chargify.com.
This site will remain available for historical reference until June 1, 2017

API Authentication

The API Authentication is implemented as HTTP Basic Authentication over TLS (HTTPS). Your API login credentials are not the same as the credentials you use to log in to the web interface. You must obtain your API credentials separately.

Please note that as of January 2016, you must use TLS >= 1.2 in order to connect to the API. See the TLS Upgrade Notice for more information.

Obtaining Your API Credentials

Your API key can be generated from the “Integrations” tab of your site dashboard.

Your http username is your “API Key”.

Your “password” is always the letter “x”.

Authenticating with your API Credentials

You will use HTTP Basic Authentication to verify your identity via the API. All requests must come over TLS/HTTPS, and be to the subdomain of the Site you wish to access. For example, if your Site’s subdomain is acme, then you would access the Customer resource at:

  https://acme.chargify.com/customers.json

An example using authentication via curl:

  curl -u api-key:x https://subdomain.chargify.com/customers.xml

or

  curl -i https://<api-key>:x@subdomain.chargify.com/customers.xml

Please review the recommendations for setting your HTTP Accept and Content-Type headers as outlined in the API Introduction

Troubleshooting

Unable to Connect

If you are unable to connect, the problem is often that you are using an old/unsupported version of SSL or TLS. In this case, Chargify will simply drop the connection, and the error message you receive may be cryptic.

Here are some common error messages that have been reported:

  • The underlying connection was closed: An unexpected error occurred on a send. Authentication failed because the remote party has closed the transport stream.

Please review the information on the TLS Upgrade Notice in order to correct the problem.