REST API Add-on

REST API Add-on

The REST API plugin simply connects the event mobile application with your WordPress site. In simple words, it syncs all your website data, including organizers, events, users, and more, with the WP Event Manager Mobile application.

REST API Installation

Just like installing any other premium plugin of WP Event Manager, you need to make sure that you have the core plugin installed on your system.

You can install the REST API plugin in two ways.

  1. Manually: You can also install the plugin manually using SFTP or FTP tools. Click here to see how you can install the plugin manually.
  2. Automatically: You can install the plugin from the backend of your WordPress. Click here to see how you can install the plugin automatically.

General settings

The general settings in the REST API plugin allow organizers to use the application freely.

Perform the following settings to work with the app:

  1. Please go to WP Admin >> Event Manager >> REST API >> General settings.
Here, you will get two options:
  • Enable REST API key: you can tick the option to enable the REST API functionality or leave it blank to disable it on your events website.
  • App Logo: you need to upload the logo that you want to display on your mobile application.

API Access Settings

These settings enable you to create an API key that further needs to be entered in the mobile application at the time of signing in.
  1. Please go to WP admin >> Event Manager >> REST API >> API access.
REST API Setting
  1. Click on Create an API key.
API key
  1. After filling in the details, such as:
    1. Description/friendly name, for identifying this key: It is the name that will help you distinguish one key from another.
    2. User or owner of the key: Choose from the list of people who can use the key.
    3. Expiry date: The date till which the key shall remain active.
    4. Permission Type: You can decide the permission type from amongst: Read, Write, or both.

  1. The admin can generate the API key by clicking on Generate API Key.

  2. After generating the API key, a user needs to click on the API access option that displays all the keys generated on this website in a dashboard.
API Access

  1. In order to revoke the API key, one can click on the key name under the description section and revoke the key from there.

Restricting the Check-in Option

Users can now restrict the Check-in option using the REST API add-on. Here are the steps to follow:

  1. Go to WP Event Manager in the admin panel.
  2. Click on REST API.
REST API

  1. Click on the API access option.
API access option

  1. Enable the Restrict Check-in option.
Restrict Check-in option

  1. Save changes.
REST API
Users can use this option to restrict attendee check-ins once the check-in time window is over.

App Branding

The App Branding option gives admins and organizers the right to select the color of the application.

The color plays a significant role in branding the application based on the company theme. For instance, WP Event Manager uses the Blue and White colors as its brand identity. Hence, the application also follows the same color scheme. Here, the user gets the freedom to choose the theme color.

To access the app branding page, you need to follow the below mentioned steps:

  1. Please go to WP Admin >> Event Manager >> REST API >> App branding.
  2. You will find the following here:
    • Primary: Base color of the application.
    • Success: Color of application messages.
    • Info: Color of the information displayed on the application.
    • Warning: Color of the warning message.
    • Danger: Color of application messages.

Additionally, users can also check how the selected color of the application looks when the dark and light themes are activated. This can be seen from the mode present on the right-hand side of the app branding settings.

App branding