Add a new admin

Management This method allows creating a new Admin in the system. The required fields are dependent on the value of the "external" field. If the value of the "external" field is set to false, then it is required to provide the value for the "plainPassword" field. Otherwise, it is required to provide a value for the "apiKey" field.

post

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

Body

or

Responses

200Success

application/json

adminIdstringOptional

Created administrator ID

Example: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

post/api/admin/data

POST /api/admin/data HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "admin": {
    "plainPassword": "text",
    "external": false,
    "isActive": true,
    "notificationsEnabled": true,
    "firstName": "text",
    "lastName": "text",
    "phone": "text",
    "roles": [
      1
    ],
    "email": "text"
  }
}

{
  "adminId": "00000000-0000-0000-0000-000000000000"
}