Check wallet type details

Management

get

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

walletTypestring · uuidRequired

WalletType ID

Responses

200

WalletType details

application/json

walletTypeIdstring · uuidRequiredExample: 3eaea517-4336-45c0-b477-f5cc1081fcdb

codestringRequiredExample: string

unitSingularNamestringRequiredExample: string

unitPluralNamestringRequiredExample: string

activebooleanRequiredExample: true

isDefaultbooleanRequiredExample: true

unitDaysExpiryAfterstringOptionalExample: string

unitDaysActiveCountintegerOptionalExample: 0

unitYearsActiveCountintegerOptionalExample: 0

unitDaysLockedintegerOptionalExample: 0

allTimeNotLockedbooleanOptionalExample: true

createdAtstring · date-timeRequiredExample: 2019-08-24T14:15:22Z

unitExpiryDatestringOptional

Expiration date for unit in format m-d.

Example: 08-24

allowNegativeBalancebooleanOptionalExample: true

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/walletType/{walletType}

GET /api/{storeCode}/walletType/{walletType} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "translations": {
    "en": {
      "name": "text",
      "description": "text"
    }
  },
  "walletTypeId": "3eaea517-4336-45c0-b477-f5cc1081fcdb",
  "code": "string",
  "unitSingularName": "string",
  "unitPluralName": "string",
  "active": true,
  "isDefault": true,
  "unitDaysExpiryAfter": "string",
  "unitDaysActiveCount": 0,
  "unitYearsActiveCount": 0,
  "unitDaysLocked": 0,
  "allTimeNotLocked": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "unitExpiryDate": "08-24",
  "limits": {
    "points": {
      "interval": {
        "type": "calendarHours",
        "value": 1
      },
      "value": 1
    },
    "pointsPerMember": {
      "interval": {
        "type": "calendarHours",
        "value": 1
      },
      "value": 1
    }
  },
  "allowNegativeBalance": true
}