Authorization

These endpoints will allow you to authorize the user.

Log user out

get

Integration This method can be used to log out current user. It will revoke all refresh tokens assigned to current user so it will not be possible to obtain new token based on stored refresh token.

Authorizations

Bearertoken

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

Responses

204

Success. No content.

No content

403

Forbidden.

application/json

get/api/token/revoke

HTTPcURLJavaScriptPython

GET /api/token/revoke HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get admin token

post

Management This method allows to login and get a JWT token for the admin

Body

application/json

usernamestringOptionalExample: admin

passwordstringOptionalExample: password

Responses

200Success

application/json

tokenstringOptionalExample: eyJhbGciOiJSUzI1NiIsInR5cCI6...

refresh_tokenstringOptionalExample: 0558f8bb29948c4e54c443f...

401

Bad credentials.

application/json

post/api/admin/login_check

HTTPcURLJavaScriptPython

POST /api/admin/login_check HTTP/1.1
Host: openloyalty.localhost
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "username": "admin",
  "password": "password"
}

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

Deprecated

Get member token

post

Management This method allows to login and get a JWT token for the member

Path parameters

storeCodestringRequired

Store code

Body

application/json

usernamestringOptionalExample: member

passwordstringOptionalExample: password

Responses

200Success

application/json

tokenstringOptionalExample: eyJhbGciOiJSUzI1NiIsInR5cCI6...

refresh_tokenstringOptionalExample: 0558f8bb29948c4e54c443f...

401

Bad credentials.

application/json

post/api/{storeCode}/member/login_check

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/login_check HTTP/1.1
Host: openloyalty.localhost
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "username": "member",
  "password": "password"
}

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

Refresh admin token

post

Management

Body

application/json

refresh_tokenstringOptionalExample: 0558f8bb29948c4e54c443f...

Responses

200Success

application/json

tokenstringOptionalExample: eyJhbGciOiJSUzI1NiIsInR5cCI6...

refresh_tokenstringOptionalExample: 0558f8bb29948c4e54c443f...

401

Bad credentials.

application/json

post/api/token/refresh

HTTPcURLJavaScriptPython

POST /api/token/refresh HTTP/1.1
Host: openloyalty.localhost
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "refresh_token": "0558f8bb29948c4e54c443f..."
}

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

Deprecated

Refresh member token

post

Management

Path parameters

storeCodestringRequired

Store code

Body

application/json

refresh_tokenstringOptionalExample: 0558f8bb29948c4e54c443f...

Responses

200Success

application/json

tokenstringOptionalExample: eyJhbGciOiJSUzI1NiIsInR5cCI6...

refresh_tokenstringOptionalExample: 0558f8bb29948c4e54c443f...

401

Bad credentials.

application/json

post/api/{storeCode}/token/refresh

HTTPcURLJavaScriptPython

POST /api/{storeCode}/token/refresh HTTP/1.1
Host: openloyalty.localhost
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "refresh_token": "0558f8bb29948c4e54c443f..."
}

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