Quick Start

To utilize full services of offer, client login is required to authenticate your application and end user. Offer service will store user data and their offer usage behalf of you so you can manage end user easily. Please refer user authentication and registration for this login process.

Get an APP Key

To use the offer API, you must include a free APP key when making a request to the API. Follow the instructions in the guide to obtaining an APP key if you have not done. Use the APP Key in the header with ‘api-key’ param name.

Request

Forming the URL
The URL for the offer request is as follows:
https://api-dev.fintiv.co:8080/{service_type}/{version}/{service_api}
Where:

• {service_type} is type of targeting offer service. The value should be one of
  • ad: Advertisement service
  • coupon: Coupon service
  • store: Store locator service
  • campaign: Campaign service
  • inbox: Message to user
  • membership: Membership/Loyalty associated with coupon
  • spservice: Master service data
  • stamp: Digital stamp service
  • wallet: Coupon wallet service
• {version} is version of API. E.g. v1
• {service_api} is the name of API.
  All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Header

Attribute	Description
api-key	APP key to authenticate requests. You can view your APP keys in the dashboard
Content-Type	application/json

Example body message
Body message should be JSON format.

{
  "couponIdList": [
    "816BA38D236244D2853FBB44E9B16526"
  ],
  "locationIdList": [
    "8F18CFAF-DF38-4A7E-B541-7031E370ED3D"
  ]
}

Response

Offer service returns response as json format. If the request is successfully processed, the return includes the result of the request and response parameters. Result code of success if 0. If the result code is other than 0, it is an error.

HTTP status code
200
Example body response message

{
  "result": {
    "code": 0
  },
  "couponInstances": [
    {
      "type": "CouponDetails",
      "couponId": "816BA38D236244D2853FBB44E9B16526",
      "couponInstanceId": "8B3A98BB-7EB9-4B31-ACB9-D7000DE2D799",
      "locationCount": 0,
      "redemptionCodeType": 0,
      "redemptionCode": "436346374",
      "redemptionBarcodeType": "QR_CODE"
    }
  ]
}