Cloudsale Loyalty API

Getting started

This API is organized around REST. Our API has mostly predictable, resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

An authentication filter is applied to most API calls. To successfully authenticate, a Base64-encoded string (in the format {locationId}|{authCode}|{password} should be passed in an Authorization header value prefixed by the word "Basic ".

Errors

We use conventional HTTP response codes. In general, codes in the 2xx range indicate a successful call. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted etc.). Codes in the 5xx range indicate an error with our API server (these are rare).

Some 4xx errors that could be handled programmatically (e.g. a card wasn't found) include an error code that briefly explains the error reported.