Update wallet’s configuration

Management

put

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

Body

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/walletType/{walletType}

PUT /api/{storeCode}/walletType/{walletType} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 479

{
  "walletType": {
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "unitSingularName": "text",
    "unitPluralName": "text",
    "active": true,
    "unitDaysExpiryAfter": "all_time_active",
    "unitDaysActiveCount": 1,
    "unitYearsActiveCount": 1,
    "unitDaysLocked": 1,
    "allTimeNotLocked": true,
    "allowNegativeBalance": false,
    "unitExpiryDate": "08-24",
    "limits": {
      "points": {
        "interval": {
          "type": "calendarHours",
          "value": 1
        },
        "value": 1
      },
      "pointsPerMember": {
        "interval": {
          "type": "calendarHours",
          "value": 1
        },
        "value": 1
      }
    }
  }
}

No content