The way to retrieve an API key from agentOS is changing. With the release of our new self-service API Key App, you'll no longer need to wait for an agentOS staff member to be able to process your request. This guide outlines how to access the new API Key App, and how to generate your own API keys.
How do I access the API Key App?
The API Key App is available through https://www.apikeys.agentos.com/ using your normal agentOS login details, or it can be accessed through the Apps tab of the agentOS Dashboard.
Please note: The API Key App is restricted to users at the 'Owner' access level only.
How do I request an API key for an existing integration?
To create an API key to utilise one of the many existing integrations that we have already implemented, you will need to complete the following steps:
- Select Create New API Key from within the API Key App.
- Select the integration you wish to generate a key for from the Integrators drop-down menu.
- After a few moments the API details will appear in your list of API Keys, allowing you to forward it to the integrator to set up your connection.
How do I request an API key to build a new website?
If you are a web developer tasked with creating a website for an agency, the agency themselves will need to complete the following steps first:
- Go to Create New API Key within the API Key App.
- Select the integration called Internal.
- This will prompt them to select which access permissions to add to the API - you may wish to liaise with them at this point to ensure the correct permissions are selected. This option will default with the Advertising API pre-selected, which will allow access to the agency's advertised Sales and Lettings data. They'll be able to select or deselect whichever permissions you wish to at this point, but please be aware that access permissions are charged as per our pricing guidelines.
- When you have selected which permissions you wish to add to the API Key, it will prompt you to enter some useful information to help you identify the purpose of the API key in the Additional Information field.
- Create the key, and after a few moments it will appear within the list of API Keys for the agency to forward to you for use.
How do I modify my API keys?
You can modify the permissions available on your internal keys at any time. In the API Key App there is a Modify button in each API Key record that will allow you to change the permissions, as well as the additional information stored against the API.
Please note: If the API key is an older one and has access to the depreciated V2 or V3 API tiers, you will not be able to modify these permissions via the API Key App. To change these please contact email@example.com with the last 5 digits of the API key and the changes you wish to make.
Keys for non-internal integrations cannot be modified, as these integrations will require specific permissions.
How do I revoke an API key?
If you no longer wish to utilise an API key, pressing the Revoke button on the API key will disable the key immediately and it will no longer work. The key will be moved to a separate section showing your revoked keys, where it will remain for two weeks. Should you change your mind during this time you can re-instate the API key and the key will become active again.
After two weeks the key will be permanently deleted, and if you wish to re-instate the connection after this point you'll need to generate a new API key in the app, and forward it to the integrator to connect to agentOS again.
How do I integrate my software program with agentOS?
If you are a third-party developer that wishes to set up a new integration between your software and agentOS then please email firstname.lastname@example.org to start the integration process. When your integration is ready to go live you will be added to the list of integrators to enable the generation of API keys by our clients for you to connect to agentOS.
Can I use my API key for multiple connections?
No. To limit strain on our databases from API requests, API keys are throttled at 50 requests per minute, if you were to provide the same API key for multiple connections you will encounter timeout and other issues. Each new integration will require its own unique API key.