Welcome to Alertify's developer documentation, where you'll find everything you need to understand and use our Open API. This includes:
Authentication: Learn how to securely log in and access the API.
Overview of Alertify Architecture: Get a clear understanding of how our system is structured.
API Specification: Detailed information on how to use the API effectively.
To access Alertify’s Open API, visit: https://api.alertify.io/openapi/
Alertify’s Open API is a token-based API that allows you to build custom integrations with your own applications or Property Management System.
Step 1: Generate an API Key On Alertify’s dashboard
Creating an API key is straightforward. You can generate multiple keys, which enable you to obtain authentication tokens for accessing different API endpoints.
Follow these easy steps to generate your first API key:
Login to your Alertify dashboard at https://dashboard.alertify.io/authentication/login
Go to ‘Settings’ on the menu
Then click on ‘Open API’ on the top menu
The, click on ‘Add New Key’
Give your API a name and then click on ‘Add’
Once you have an Api Key, you can use it to get an authentication token. This allows you to securely access various API endpoints.
(1) Go to the following link: https://api.alertify.io/openapi/
(2) Then, scroll down to ‘Authentication’ on the left navigation bar
(3) Under ‘Get API token’, click on the ‘Fill Example’ button, and then paste your API key from your Alertify dashboard where the text ‘String’ is, so it looks like the following:
(5) Once your API key is copied, scroll to the top to ‘Authentication’, add 'Bearer' with a space and then paste your API key in the small textbox and click ‘Update’. This will give you access to various API endpoints in the dashboard.
That’s it - you’re all done!
If you encounter any issues or require further assistance, please don't hesitate to reach out to our dedicated support team at support@alertify.io. We're here to help you make the most out of your Alertify experience.