Link Search Menu Expand Document

Versioning

Introduction

Occasionally Spaaza makes changes to the payload sent to or response received from an API endpoint. This may include adding new request or response fields. In order to maintain backwards compatibility with existing API clients a versioning policy is put in place. The aim of this policy is to make using endpoint features as simple as possible.

Usually a Spaaza API endpoint maintains backward compatibility without requiring special flags, but in the case that a specific version is required, the API documentation for that endpoint will show clearly what is needed. If there is no information about versioning in the documentation for a specific endpoint, then there is no need to do anything. Spaaza recommends sending an appropriate version header with all API requests.

Occasionally version-specific changes become available in the Spaaza API which affect multiple, or all, endpoints. This kind of change is described in the section API-wide version information below. Again, this kind of change is designed to be non-breaking and as backwards-compatible as possible.

It should be noted that Spaaza’s approach is generally that we may add optional request fields, or fields to response JSON, without a version change, but that we will only remove fields, or change their type or name, in a new API version, and that that change should avoid affecting API clients consuming endpoints with existing versions.

Using a specific endpoint version

With most Spaaza API endpoints version-specific differences are implemented. In order to use the latest version of an API endpoint, a version header is sent along with the request to the API endpoint. The documentation for a specific endpoint will always contain information about which version number should be used if there are changes differences that are specific to that endpoint.

There are also version-specific differences that apply to all endpoints, such as how errors are formatted in API responses. These are detailed in the ‘API-wide version information’ section below.

The following header is used for specifying a version:

  • X-Spaaza-API-Version: <version number>

Spaaza uses standard semantic numeric major.minor.fix version numbering, for example:

  • X-Spaaza-API-Version: 1.4.10

NOTE that if no X-Spaaza-API-Version header is supplied then a version number of 1.0.0 is assumed.

API-wide version information

This section includes information about version-specific changes which affect multiple, or all, endpoints in the Spaaza API. In the case that these changes affect all endpoints, for example a change in the way error responses are handled between different versions, a description of the change is not usually included in the documentation for any specific individual endpoints.

A description of each of this kind of version-specific change is shown below.

1.4.11 - Update to get-campaigns

  • Switch default behaviour of exclude_inactive in the get-campaigns API endpoint. Previously, inactive campaigns would be included in the API response by default unless the exclude_inactive parameter was set to true. Now, inactive campaigns are excluded by default unless exclude_inactive is set to false.

1.4.10 - Updates to add-user, get-user, get-login-status,alter-user , login and get-card

  • Update gender field in user object to support male, female, nonbinary, transgender, agender, genderqueer, genderfluid, bigender, twospirit, androgynous, pangender, neutrois, demigender and other.

1.4.9 - Updates to shopper.transaction webhook

  • Update shopper.transaction webhook replace shopper object with user object.

1.4.8 - Additions to responses to get-basket-price and add-basket

1.4.7 - Updates to add-basket

  • Update the item_price request field to change definition item price net of vouchers and other Spaaza rewards to be redeemed.
  • Add the item_original_price request field to send the original gross per-unit price of a basket item before Spaaza vouchers and rewards.

1.4.6 - Updates to add-user, get-user, get-login-status,alter-user , login and get-card

  • Update birthday date format in user_info response object to YYYY-MM-DD.

1.4.5 - Updates to add-basket and get-card

  • Update add-basket response to include item_original_price in request object for basket item and to display voucher_distribution_estimated warning for requests that include on the fly basket campaign vouchers, but the item_original_price is missing from all the basket items.
  • Update get-card response to return result_type of get-user-entity-card when API client version < 1.4.5

1.4.4 - Update get-card display for cashback campaigns.

  • Returns Campaigns of type cashback as cashback within the promotions block.

1.4.3 - Update currency display in get-card response

  • Returns a standard currency object across all campaign types within get-card promotions block.

1.4.2 - Allow float values for basket item quantities

  • Allow float values for basket (line) item quantities in get-basket-price and add-basket
  • Update parameters to allow multiple parallel wallets
  • Previous name of basket_vouchers array in response JSON of get-vouchers changed to vouchers.

1.4.1 - Remove URL format requirements

  • Remove requirement for .json or .php suffixes at the end of API endpoint URLs
  • Remove requirement for v1/ in API endpoint URLs

1.4.0 - Updates to formatting of JSON error responses

  • Error responses for all API endpoints updated to reflect semantic correction of errors -> error where only a single error is returned.

API clients using a version number less than 1.4.0 will receive the previous error formatting in the JSON returned in the error response. Documentation for older clients is available on request.

1.1.8 - Updates to formatting of JSON in get-basket-price and add-basket endpoints.

  • get-basket-price endpoint request and response JSON updated to change parameter names
  • add-basket endpoint request and response JSON updated to change parameter names
  • lock-voucher endpoint parameters and response JSON updated to change parameter names

API clients using the above endpoints should use a version number greater than or equal to 1.1.8. Documentation for older clients is available on request.