LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
Powered by GitBook
On this page
  • Admins
  • Adding new Admin
  • Admin Password
  • Permanent User Token
  • Managing Admins

Was this helpful?

  1. Main Features
  2. Settings

Admins

In this section, you will learn how to manage the admins of your loyalty program.

Last updated 2 months ago

Was this helpful?

Admins

When your tenant is first set up, you receive a set of login credentials for the Administrator role that has full permissions. If there are others on your team or service providers who need access, you can create a separate user account for each from this section.

To limit the sections or elements that Admin users can access when they log in, you must first create a role with limited permissions and access only to the necessary resources. See the 'Roles ' section to learn more about the roles. Then, you can assign the role to a specific user account.

Admin users, who are assigned to a restricted role, can see and/or change data only for resources that are associated with the role

Admins list includes both active and inactive Admin users – inactive are grayed-out. You can also see their status in the Active column. Additionally, the Admins list grid provides basic information about Admins – name, surname, email address, authenticate method, and information about whether notifications are enabled.

To access the Admins list go to Settings -> Admins. All created Admins will be listed in the table. You can change the number of rows displayed per page by clicking on the arrow icon below the table and picking a handy number from the list.

Adding new Admin

To create a new Admin:

  1. Go to Settings -> Admins

  2. Click the +ADD ADMIN button, and you will land on the 'Add Admin screen.'', complete the following information:

    • Name

    • Last name

    • Role - pick one from the list

    • Phone number

    • E-mail (This email address must be different from the one that is associated with your original Admin account)

    • Password/Repeat password

  3. You also can allow the user to use a permanent token for API requests

  • To allow the admin account to authenticate calls via an API key, do the following:

    • Go to the Permanent user token section

    • Use the Generate new key option

    • Set the name for the key, and should it have an expiry date (recommended)

    • Copy the API key and save it. You will not be able to access the key upon closing the window.

    Please note that the API token does not replace the password. The API key is a permanent token used to authenticate your API, not for logging into the Admin Panel.

  • To authenticate the user via Password, do the following:

    • Assign a Password to the account that they use for login to Admin Panel.

  1. Switch Active toggle to active (its color should change to purple)

  2. To receive push notifications, switch Notifications enabled toggle to active

  3. When all is done click on the ADD ADMIN button


Admin Password

To allow the person to log in to the Admin UI, a password needs to be set upon creating the account:

If an Admin forgets the password, they can recover it themselves, using the password recovery option.

A recovery link will be sent to the email address connected to the account.


Permanent User Token

In this subsection, you can start using a permanent user token - "API key".

To add an external token:

  1. If the admin account wasn't created yet, head over to Admins and ADD ADMIN

  2. Once the admin is added, open the account's details and use the Generate new key option

  3. Set the name for the key, and should it have an expiry date (recommended)

  4. Copy the API key and save it. You will not be able to access the key upon closing the window.

API Keys are generated by the system and can't be edited.

A permanent token can be provided using headers or a query parameter.

Using headers:

curl http://localhost:8181/api/admin \
    -X "GET" -H "Accept: application/json" \
    -H "Content-type: application/json" \
    -H "X-AUTH-TOKEN: customPermanentToken"

Managing Admins

To modify already existing records, click on the overflow button (three-dots), list with 2 options will appear:

  1. Edit, where you can edit previously saved information and then click on the SAVE SETTINGS button

  2. Enable/Disable notifications (accordingly, if the admin has this option off or on previously)

If you would like to dismiss Add Admin or Edit Admin screen just click on the 'X' button next to the header.

The Technical Guide for reference: .

API Key authentication