How Can We Help?

Rest API

PostedApril 25, 2024
UpdatedMay 6, 2024
Print
< All Topics

The Rest API plugin connects your food mobile application with your WordPress website. It syncs all the food and restaurant-related data like restaurant listings, food listings, order details etc on your website with the WP Food Manager mobile application.

Installation of Rest API

Like all other premium plugins of WP Food Manager, the installation of Rest API requires the core plugin. 

There are two ways to install the plugin.

  • Manually: You can install the plugin manually using SFTP or FTP tools. Click here to learn the process. 
  • Automatically: You can install the plugin automatically from the backend of your website. Click here to learn the process.

General Settings

The ‘General Settings’ option allows the user to use the application with ease.

Follow the path to go to ‘General Settings’.

  1. WP-admin>>Food Manager>>Rest API>>General Settings

    2. General-Settings-Tab

  2. It has three options.
    • Enable Rest API Key: Tick the box if you want to enable the Rest API functionality on your website.
    • Application Name: Put the name of the application.
    • App Logo: Upload the logo you want to display on your mobile application.

      • General-Settings-Options

API Access Settings

The ‘API Access’ option allows you to create an API key, which you should enter in the application while logging in.

Follow the path to go to API Access. 

WP-admin>>Food Manager>>Rest API>>API Access

Take the steps mentioned below to create your API key.

  1. Go to API Access.

    2. Api-Access-Tab

  2. Hit the ‘CREATE AN API KEY’ button.

    3. Create-An-Api-Key

  3. Give all the required details in their respective fields.
    • Description : Give a name to differentiate one key from another.
    • User Owner of these Keys: Select the person who can use the key from the dropdown.
    • Expiry Date: Put the date till which the API key shall remain active.
    • Permissions: Select the type of permission from amongst- Write, Read, or Both.

    Create-An-Api-Key-Details

  4. Click the ‘Generate API Key’ button to generate the API key.

    5. Create-An-Api-Key-Successfully

  5. After generating the API key, click ‘API Access’ to see all the keys generated on this website.

    6. Api-Key-Dashboard

  6. To revoke an API key, click on the key name under the ‘Description’ section. and then Revoke.

    7. Api-Key-Dashboard-Revoke-Option

App Branding

The ‘App Branding’ option allows you to select the application color.

Color selection is crucial in application branding. Consider your food business theme while selecting the color. For example, WP Food Manager uses orange and white colors as its brand identity. Hence, the application should have the same color.

Follow the below-mentioned path to go to the ‘App Branding’ option.

WP-admin>>Food Manager>>Rest API>>APP Branding

Take the steps discussed below to set your app color.

  1. Go to APP Branding.
  2. It has the following options.
    • Primary: The main color of the application.
    • Success: Message’s color of the application.
    • Info: Color of the displayed information of the application.
    • Warning: Warning message’s color.
    • Danger: Application message’s color.

Check how your selected colors for the application look after activating the dark and light theme. Go to the mode on the right-hand side of the app branding setting and activate the dark and light themes to test the look.
App-Branding

Table of Contents
Close