How to add an API Key

An API (Application Programming Interface) Key is used to authenticate an application calling the API, such as your website. Different platforms may implement and use API keys in different ways, however if your web developer requests an API Key, this article will explain how to generate them in Homhero.

1. Click Booking Engine > API Keys from the Homhero side menu
2. Click the Add button
   
   
   
   
3. Active - This toggle will default to Active
4. Allow Payments - Turn this toggle on if you would like to Allow Payments to be delivered to Homhero for this API Key. This is a requirement for our Holidaypaws Third Party Integration
5. Booking Source - Select the Booking Source that applies to this API Key. If no Booking Source is selected, this will default to your website 'Default Website Direct'
6. Description - Add a description to explain what this API Key is used for
7. Limit to Listings - Click the SET button if you would like to limit this API Key to specific Listings
8. Exclude Listings - Click the SET button if you would like to exclude any Listings from this API Key 
9. Categories - Click the SET button if you would like to limit this API Key to a specific Category
10. Uplift % - Add a percentage if you would like to add an uplift to all prices using this API Key
11. Uplift Sundry - If you are using the Uplift %, you will need to assign this to a Sundry. Please click here for instructions on how to create a new sundry
12. Save - Click Save to complete the setup
    
    
    
    
13. The API Key will generate automatically upon clicking Save. You can copy this key and provide this to the user or developer that requires this authentication.
    
    

Private API Key/Password
If you require access to private API methods, for reservations, properties. Please send a support request to [e-mail] with the Subject: "Create Private API Key/Password". You will then be given a secure one time link with password that only lasts for 7 days and can only be used once.  If you are providing the API Key/Password to another developer, please don't use the link as it is one time only.