Checking if API Key Setup is enabled
Go to your Access Levels and type "API" into the filter.
- If you can see the API Key Setup Access Level, it means your site has API turned on.
If you are an Administrator of the site, you can edit your access and tick Modify All to be able to manage the setup. If you are not an Administrator, ask them to grant you that access.
- If you can not see the API Key Setup Access Level and you are an Administrator of the site, send our team an email to help@airmaestro.net with a request to enable the API Key Setup feature.
Once we confirm we enabled the API feature for your site, you can go to your Access Levels > API Key Setup and give yourself the Modify All access.
Creating Service Accounts
Services accounts are users inside of Air Maestro that are specifically designed for API integrations. They appear throughout the system under "Service Accounts", for example in a personnel picker.
They can have access levels and templates granted to them like a normal Air Maestro user. They, however, cannot log into the system and can only interact through the Air Maestro API using an API Key.
- Go to Site Setup > General > API Key Setup.
- Click on the Create New Service Account button.
- Fill in the details of the service account.
Give it a Service Account Name for easy identification (cannot contain spaces or special characters).
The Organisation is, for instance, the integrator.
The Email Address should be the email address of the primary contact of the integrator.
- Press Create. The new Account will now show on the list.
If you wish to make any changes to the entered details, click on the pencil icon.
Granting Access to a Service Account
Service accounts, like normal Air Maestro users, must be granted access levels in order to interact with the system. The access levels are linked to the Service Account and not API Keys. API Keys get their access from the linked Service Account.
Clicking the key icon on a Service Account in the list will bring up a popup window to grant access.
See Understanding Access for more information.
Generating API Keys
API keys can be used to authenticate with the Air Maestro API. They must be linked to a Service Account and inherit their access from it.
See Authenticating With the Air Maestro API once you have an API Key.
- Go to Site Setup > General > API Key Setup.
- Within the API Keys section, click on the Generate New Key button to the right.
- Fill in the details of the API Key.
You can only choose one Service Account per key, however, the same Service Account can be allocated to multiple API Keys.
When API is about to expire, the selected Service Account and the selected Notification Personnel (existing in Air Maestro) will be notified.
- When ready, press Generate.
- You will see a window with a generated API Key. Copy this key to save it, as it will not be retrievable later on.
- The key will now appear on the list of API Keys.
The refresh button will refresh the expiry by the specified amount chosen in the setup. | |
The expiration button will expire the key instantly. Use this if you think or know an API Key has been compromised. |
|
The edit button will allow you to change the notification personnel and when they get notified. No other details can be edited. |
Comments
0 comments
Please sign in to leave a comment.