Currently, the preferred method for interacting with our API is through the use of an API key, which can be generated directly in the Onomondo app.
Once you've logged in, simply head over to the API keys tab:
Adding a new API key
Generating a brand new API key is pretty straightforward.
Click on the button "+ New API key" on the right-hand side.
Give your key a unique name.
In the "Restrict access" field:
Leave the field empty if you want access to all resources, or
Select Tags which the key should be limited to.
Click "Create API key".
The app will display your unique API key. Store it somewhere safe. Never share it with anyone.
Warning:
API keys are only shown once when they are generated.
If the key is lost, you will have to generate a new key and delete the previous one.
Once you have your API key set up, you can start querying the API:
Editing existing API keys
You can always go back and edit the access level of the API key, as well as the name. However, you will not be able to see the value of the API key again.
Go to the API keys tab.
Click "Edit" next to your API key.
Edit name and/or tags.
Click "Save changes".
A note on editing Tags:
If the API key has been paired with "All resources", selecting Tags will limit the key to the given set of Tags.
If the API key has been paired with a set of Tags - removing all Tags will default the key's access to "Nothing", effectively disabling any access permissions there were in the first place.
Deleting API keys
Deleting the key is similar to editing.
Go to the API keys tab.
Click "Edit" next to your API key.
Click "Delete API key" in the top right corner.
When the app asks for confirmation, click "OK".
If you have any further questions on this topic, reach out to us at [email protected] or via in-app chat.