AlbumExposure API

Introduction

The AlbumExposure API is implemented as vanilla JSON over HTTPS. Send the Content-Type: application/json header to identify the format along with the json extension on the end of the request.

Making requests

When you're using the API, it's always through an existing AlbumExposure user.

The preferred method of authentication is using OAuth. Contact us for credentials.

Note: Basic authentication is also available, but may be deprecated in the future in favor of OAuth.

Be sure to set both the 'Content-Type' and 'Accept' headers to the appropriate type to identify the request and response format. Example with json and Curl:

curl -H 'Accept: application/json' -H 'Content-Type: application/json' \
          -u username:password \
        https://albumexposure.com/api/albums

Responses

If a request succeeds, it will return a status code in the 200 range and often, a JSON formatted response. Note that, in general, if a request causes a new record to be created (like a new album, or spread, etc.), the response will use the "201 Created" status. Any other successful operation (like a successful query, delete, or update) will return a 200 status code.

If a request fails, a non-200 status code will be returned, possibly with error information in JSON format as the response's content. For instance, if a requested record could not be found, the HTTP response might look something like:

HTTP/1.1 404 The record could not be found
        Date: Thu, 16 Mar 2006 17:41:40 GMT
        ...

Conventions used in this documentation

#{text} Indicates text that should be replaced by your own data

... Indicates content from the response has been elided for brevity in documentation.