fbpx
Join our webinar on how to grow your events business with WP Event Manager on 29th September at 11:00 am EST.Register Now!
How can we help?

Rest API

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.

Manually: You can also install the plugin manually using SFTP or FTP tools. Click Here to see how you can install the plugin manually.

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 allows 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.
  2. Rest Api General Settings Tab

  3. Here, you will get two options 
  • Enable Rest API key: you can tick mark the option to enable the Rest API functionality or leave it blank to disable it from your events website.  
  • App Logo: you need to upload the logo that you want to display on your mobile application.

Rest Api General Settings Options

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.
  2. Rest Api Api Access Tab

  3. Click on Create an API key.
  4. Create An Api Key

  5. After filling in the details such as,
  6. a. Description friendly name, for identifying this key: It is the name that will help you distinguish one key from another.

    b. Events: You can either choose all the events on your website or any particular event that you wish to link your application with.

    c. User or owner of the key: choose among the list of people who can use the key.

    d. Expiry date: The date till which the key shall remain active.

    e. Permission Type: You can decide the permission type from amongst- Read, Write, or both.

    Create An Api Key Details

  7. The admin can generate the APP key, by clicking on Generate API Key.
  8. Create An Api Key Successfully

  9. 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.
  10. Rest Api Key List

  11. In order to revoke the API key, one can click on the key name under the description section, and revoke the key from there.
  12. Rest Api Key Revoke Option

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. 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 theme is activated. This can be seen from the mode present on the right-hand side of the app branding settings.

App Branding Settings

Quick Links
Close