Bombplates features an API which allows external services to access certain features of the site at the band member level

API Key

Each band site has a single API key which can be reset at will and shared out to various services.

The key is accessed by logging in to a bombplates site, and going to the site settings form Settings > Site Settings > General (manage/site_settings)

There will be a checkbox prompting to generate a new API key and - if it has been generated already - the API key itself.

Several other forms throughout the site may also display the API key for ease-of-access

Authentication

Any service that wants to access the API must pass the API key as a GET or POST parameter named api_key

e.g. If the API key is "1234567890abcef", a service could get the site status by either of the following

GET /status?api_key=1234567890abcdef HTTP/1.1
Host: SOMEBAND.bombplates.com

Or

POST /status HTTP/1.1
Host: SOMEBAND.bombplates.com
Content-Length: 24
Content-Type: application/x-www-form-urlencoded

api_key=1234567890abcedf

Returns

All endpoints should return json-encoded objects on success. They may return either json-encoded error messages or HTML error pages on error. (e.g. the site's 404 or 403 page)

Functionality

Status check - get a basic overview of the site and its current status

Fan club membership sales - generate and verify fan club verification codes