You need a Master Console API key to authenticate API requests for creating and configuring your workspaces. An API key is a unique identifier associated with your account. It is necessary for usage and billing purposes.
Create your Master Console API key
You can access the API Keys section from the left sidebar of your Master Console.
Note that you can have up to 5 API keys per Master Console.
If you delete an API key, you can no longer use to authenticate your requests.
Recommendations
- Name your API key explicitely. It will be easier for you to identify which API key can be deleted, for example.
- Copy your API key and store it in a secure place on your side. For security reasons, Universign does not store API keys in clear text.
Authenticate your request
Once you created your Master Console API key, you are ready to authenticate your request. Add it to the request header as the value of the username followed by a colon: -u your_API_key: (the password field can be left empty).
Alternatively, you can authenticate via bearer auth: -H "Authorization: Bearer your_API_key".
Note that a Master Console API key cannot be used to authenticate requests such as transaction, seal or timestamp requests.
Authentication errors
If you don’t provide an API key or provide an invalid one when authentication is required, you will receive a 401 - Unauthorized response.
If the API key you provided does not grant you access to the resource, you will receive a 403 - Forbidden response.
