Captain Pass API - v1

Root URL

SSL only

It is required that all requests to this API are done over SSL.

HTTP headers

The following headers must always be set:

Content-Type: application/json
X-API-KEY: your_api_key

Authentication method

Requests are authenticated using an API Key that you can obtain from your Captain Pass account page.
This API Key should be sent along every request in the form of a HTTP Header: X-API-KEY.

Error handling

Errors are returned using standard HTTP error code syntax. Any additional info is included in the body of the return call, JSON-formatted.
Error codes not listed here are in the REST API methods listed below.

Code Reason Description
200 OK Everything went fine
201 Content created The resource was created as requested
304 Not modified Whatever it is you asked, nothing was changed
400 Bad request Most likely to happen when the request body is empty (POST / PUT) or because the JSON body could not be parsed.
403 Forbidden access Your API Key might be wrong, or you are trying to access a resource you do not own.
404 Not found The requested resource was not found.
405 Request method not supported. The HTTP verb you used is not available for this request.
500 Internal server error Something is wrong on our side. If this happens, do not hesitate to contact us right away.
509 Too many requests You sent too many requests in a short amount of time. You must wait a little before resuming