API Keys

To create a custom booking journey through your own website an API key can be generated which links bookings and your site together. A key can be generated at either estate, company or outlet level. The API Keys section enables API Keys to be generated for the organisation to use the external bookings API.

API Keys Topics
Navigate to API Keys

Adding New API Keys

Follow these steps to add an API Key:

  1. Click Add New API Key

  2. Enter a Name for the key

  3. Enter a Password for the key

    Passwords must be at least 10 characters in length

  4. Select either Estate | or Company | or Outlet for the key to apply

  5. Select the integrator type (Web is to be used by default)

  6. Click Save Changes

Changing Passwords

It is only possible to update passwords. Key names or IDs are not able to be amended.

Updating or editing the API key password will break any integrations using the old key unless they are updated accordingly

Follow these steps to change an API Key password:

  1. Click Edit against an existing API Key

  2. Update the Password

  3. Click Save Changes

Deleting API Keys

Zonal recommend you always check carefully that the key you are about to delete is not in use, it is recommended to disable the key in the first instance. Once a key has been delete it is not possible to be reinstated

Follow these steps to delete an API Key:

  1. Select an existing key, click Delete

  2. Confirm OK to delete the key

Field Settings & Information

API Key Details

The following information describes each of the API Key fields.

The following table of information describes each of the API Key fields:
Field Description
API Key Name

Name of the API Key
Password

Password of the API Key with minimum of 10 characters
Outlets

Outlets that will use the API Key