Generate API Keys
To generate an API key and a Secret key for accessing the Zirius API, you must have admin rights within your Zirius Pluss account. Only users with admin privileges can create API keys in the Zirius Pluss portal.
Steps to Create API Key:
Navigate to the API Keys Section: Log in to your Zirius Pluss account and navigate to the API Keys section. You can find this under the "Company" menu, specifically under "API Keys"
Create a New API Key: Look for the "New API Key" button within the API Keys section and click on it to initiate the key creation process.
Provide Details: When creating a new API key, you'll need to provide the following details:
Name: Choose a descriptive name for your API key to easily identify its purpose.
Description: Optionally, provide a brief description that explains the purpose or usage of the API key.
Modules & Rights: Specify the modules and their corresponding rights that the API key will have access to. This ensures that the API key is granted the appropriate permissions based on the functionality it needs to access.
User Association: Optionally, associate the API key with a specific user within your company. This allows you to track and manage API key usage more effectively.
Save the API Key: Once you have provided all the necessary details, save the API key. The Zirius Pluss portal will generate both an API key and a Secret key for you to use in your API requests.
Securely Store the Keys: Ensure that you securely store both the API key and the secret key. These keys are used for authentication and should be kept confidential to prevent unauthorized access to your Zirius Pluss account and data.
By following these steps, you can generate an API key and a Secret key for accessing the Zirius API, allowing you to securely integrate Zirius Pluss features into your applications and systems.
Last updated