How to find and manage the API keys for your portal
Validis offers an API so you can pull data into your own systems rather than working only through the portal. It is an optional feature, so if you cannot see the settings described here, speak to your Validis representative about adding it to your portal.
The API documentation itself lives at docs.validis.com. This article covers the keys, which is what the portal side of it amounts to.
Please note
You need the appropriate permissions to reach Portal Settings.
Finding the settings
Select the settings icon at the top right of the portal, beside the help icon.
That opens Portal Settings. In the menu on the left, select API. It sits under Integration, at the bottom of the menu rather than with the other portal settings.
Your two keys
You are given two keys, a Primary Key and a Secondary Key. Both work, and both give the same access. They exist as a pair so that you can replace one while the other keeps your integration running.
Each key is hidden until you ask to see it. The eye icon reveals the key, and the icon beside it copies the key to your clipboard, which is the safer way to get it into your own system than reading it off the screen.
Please note
Your API keys are credentials. Anyone holding one can reach your data through the API, so treat them the way you would treat a password: do not email them, do not put them in a shared document, and reveal them on screen only when nobody is looking over your shoulder.
Regenerating a key
Regenerate Key replaces that key with a new one. Each key has its own button, so you can regenerate one without touching the other.
Regenerating is what you do if a key has been shared too widely or you simply want to rotate it on a schedule. The old key stops working, so anything still using it will start failing. Copy the new key into your integration as part of the same piece of work, rather than regenerating and coming back to it later.
If you are rotating both keys, do them one at a time. Regenerate the primary, move your integration onto it, confirm it is working, and only then regenerate the secondary. Doing both at once leaves you with nothing that works in the meantime.