Generate API Client
To generate a Client Id and Client Secret for accessing the Zirius API, you must have admin rights within your Zirius Pluss account. Only users with admin privileges can create API Clients in the Zirius Pluss portal.
Steps to Create API Client:
Navigate to the API Clients Section: Log in to your Zirius Pluss account and navigate to the API Clients section. You can find this under the "Company" menu, specifically under "API Clients"
Create a New API Client: Look for the "New API Client" button within the API Client section and click on it to initiate the client creation process.
Provide Details: When creating a new API Client, you'll need to provide the following details:
Name: Choose a descriptive name for your API Client to easily identify its purpose.
Description: Optionally, provide a brief description that explains the purpose or usage of the API Client.
Token Expiry Time: Choose a expiry time for access token. If nothing selected by default token expiry is set to 1 Hour.
Modules & Rights: Specify the modules and their corresponding rights that the API Client will have access to. This ensures that the API Client is granted the appropriate permissions based on the functionality it needs to access.
Save the API Client: Once you have provided all the necessary details, save the API Client. The Zirius Pluss portal will generate both an Client Id and Client Secret for you to generate a access token.
Securely Store the Secret: Ensure that you securely store both the Client Id and Client Secret. These details 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 Client ID and Client Secret for accessing the Zirius API, allowing you to securely integrate Zirius Pluss features into your applications and systems.
Last updated