The steps in this article, cater to the following audiences:
Businesses that are new to Zenoti and want to utilize its API functionality.
Existing businesses that need to generate new API Keys for apps other than the Default app.
Important: The process to generate and update an API key has changed.
Earlier navigation: At the organization-level, Admin > Setup > API
New navigation: At the organization-level, Admin > Setup > Apps.
Note: Generate a new API key for each individual app. For example, if you have a Web Booking app and a Mobile Booking app, you must generate two API keys respectively.
To generate a new API key
At the organization-level, navigate to Admin > Setup > Apps.
The Manage Applications page opens.
The Create Application page appears.
Enter the following information:
Name: Enter the name of the application.
URI: Enter the URL of your Website or the application.
Description: Enter a brief description of the app for which you are generating the API key.
Login User Type: Select any one of the following
Guest: Select this check box if this is a guest facing application and the login user is a guest.
Employee: Select this check box if this is an internal app and the login user is an employee of your business.
Source App: Select any one of the following from the drop-down list:
External CMA: Select this option if the API is for the CMA application. All the appointments booked from this application will be marked with the Mobile Booking icon.
External Webstore: Select this option if the API is for the Webstore. All the appointments booked from this Webstore, will be marked with the Web Booking icon
Client App: Select this option if the API is for the client app of your business.
Bot: Select this option if the API is for a bot. All the appointments booked by the bot will be marked with the Bot Booking.
Post Logout Redirect URL: To redirect your users to a URL after they logout, click Add, and the enter the URL.
Post Login Redirect URL: To redirect your users to a URL after they login, click Add, and enter the URL.
The Scope page appears.
Select the check box of the respective API groups to add it to the application.
Note: Click the “+” symbol to view the API data of a single group.
Select all the relevant API groups and, click Next.
The Credentials page appears.
Zenoti generates a new Application ID and a Secret Key.
Copy the Application ID and the Secrets on a notepad.
Note: Make a note of the Application ID and the Secrets before you navigate away from this screen. If you navigate away from this page, you must restart the API generation process from the beginning.
Click Generate API Key.
Zenoti generates a new API Key for your business and the app.
Copy the API key on a notepad.
Note: Make a note of the API Key before you navigate away from this screen.
You have successfully generated a new API Key for your business and your app.
Note: This API Key will work only for the designated app. If you have multiple apps, you must generate separate API Keys for each app. Repeat this process from Step 1 for each app.