App API change log

Here is a list of all updates to the App API:

 

version 3.0.4
– Added function to validate codes through the app

version 3.0.3
– Added functionality to process the shop basket through Liquid Barcodes (and not a 3rd party)
– Deprecated OfferToken in Get /ShopOffers (replaced with OfferInstanceId)

version 3.0.1
– Added shop offer category
– Corrected typos

version 3.0.0.1

GET /ratings/categories
– Added CategoryId
– Removed ProductCategory

POST /Ratings
– Added RatingId
– Removed StoreId

version 3.0.0

Change log Unified app feed

General
– All signatures are using SHA-2 256
– Deterministic PIN follows the same registration flow (POST /initialize => POST /pin => POST /user)
– The registration process has significantly changed to accommodate GDPR requirements
– All GET calls now takes the syntax /somefunction?parametername1=parametervalue1&parametername1=parametervalue2
– When mandatory consent has not been given, all functions apart from the registration functions will return a corresponding error code
– When the user needs to be forced to re-register, all functions apart from the registration functions will return a corresponding error code

POST /app
– Name change to POST /initialize
– InstanceId parameter has been removed
– UDID has changed name to DeviceId
– Optional culture parameter when app supports multiple languages (consent text needs to be presented in multiple languages)

POST /pin
– Now used also for deterministic pin applications (returns the PIN in the response)

POST /user
– Emails parameter support multiple emails (array)
– Deprecated PreferredStore is no longer supported
– Can set SelectedPreferredStore from the app (the user’s preference)
– Parameters for ApprovedConsents and Revoked consents added
– The response returns the entire user model

PUT /user
– See POST /user

GET /User
– Changed syntax (see general section)
– Emails parameter support multiple emails (array)
– Deprecated PreferredStore is no longer supported
– will get SelectedPreferredStore from the app (the user’s preference)
– Parameters for ApprovedConsents and Revoked consents added
– The response returns the entire user model

User Model
– Includes both the PreferredStores (allocated by the system) and SelectedPreferredStores (selected by the user)
– emails parameter includes all emails
– User’s selected culture is now included
– The status of all current consents (whether approved or revoked) is returned
– Link to HTML page where the user can get the complete personal details is included

GET /languages
– Changed syntax (see general section)

Coupon object
– Renamed to Content model
– Deprecated CampaignId has been removed
– CouponId is renamed to ContentId
– Deprecated URL has been removed
– TopCouponImageUrl changed name to TopImageUrl
– TopCouponText changed name to TopText
– BottomCouponText changed name to BottomText
– BottomCouponImageUrl changed name to BottomImageUrl
– OverlayURL has changed name to ContentUrl
– Type options has reduced to Coupon and HTML
– Deprecated Version has been removed
– ProductCategory is replaced by the RatingCategory is associated with this content. The RatingCategory includes Id and Name
– Shareable parameter has been replaced by ShareType
– Optional parameter GiftCardBalance has been added
– Activated parameter has been added (currently always true)

GET /coupons
– Changed syntax (see general section)
– Changed name to GET /content
– Complete parameter has been replaced by array of SectionIds
– Returns an array of sections with Id, Name and array of content
– Reset user response is now included as an error code

GET /coupons/group
– Removed

Get Location Based Coupons
– Removed

GET /coupon
– Changed to a POST function
– Changed name to POST /share
– Changed CouponId to ContentId

GET /RatingState
– Changed syntax (see general section)
– Changed name to GET /ratings/categories
– The response contains an array for the first rating opportunity per rating category
– RatingAvailable has been replaced by PendingRating parameter
– Response has been reorganised and parameters renamed

POST /RateProduct
– Changed name to POST /rating
– AppId has been removed
– ShopId has changed name to StoreId

GET /ratings
– Changed syntax (see general section)
– Removed UserId and Appid as parameters are not needed
– ShopId has changed name to StoreId

GET /StoreStats
– Changed syntax (see general section)
– Removed UserId and Appid as parameters are not needed
– ShopId has changed name to StoreId
– ProductCategory has changed name to CategoryId
– ShopName has changed name to StoreName

GET /Stores
– Changed syntax (see general section)
– UserId removed as parameter no longer needed
– Deprecated Tag parameter has been removed

GET /StoreTags
– Changed syntax (see general section)
– Has changed name to GET /storetagids
– UserId removed as parameter no longer needed
– Deprecated Tag parameter has been removed

GET /validreferral
– Changed syntax (see general section)

POST /referral
– No change

POST /device
– No change

GET /receipts
– Changed syntax (see general section)

GET /shopoffers
– Changed syntax (see general section)
– Added MaximumAmount parameter
– Added Local shop offer parameters

List of errors
– Added ConsentAgeException (47), ConsentException (48) and ResetUserException (49) error codes

 

version 2.1.12

– Corrected email type in the specification

version 2.1.11
– Changed all signature calculations to SHA-2 256 variant (MD5/SHA-1 will continue to work for a time period)

version 2.1.8
– Allows the MSN to be set on the user (only when using deterministic/static pin)

version 2.1.7
– Added additional error codes

version 2.1.6
– Corrected underlying functionality to support ShareByUrl instead of SharedByUrl

version 2.1.5
– Corrected typo in ShareByUrl to SharedByUrl
– Added error ID 46: blacklisted user

version 2.1.3
– Clarified the use of Get / coupon calls

version 2.1.2
– Clarified the use of External StoreId/ShopId in the PUT/POST /User calls

version 2.1.1
– Formatting changes
version 2.1.0
– Added Shop function to display a list of coupons that can be bought in a virtual store
– Added functionality to display receipts in the app
– Added functionality to forward receipts from the app
– Added optional logo field on the Stores data
– Fixed an issue with the new share function