Introduction
This guide outlines the process for generating and testing API keys within the Realview Hub platform. API keys are essential for programmatic access to your data, enabling external integrations and custom applications to interact securely with your Realview Hub account.
Prerequisites
Access to the Realview Hub web application.
Permissions to manage API settings within your organization's configuration.
Steps
1. Navigate to API Settings
From the Realview Hub dashboard, locate and click on Settings in the main navigation menu.
In the left-hand sidebar under Settings, scroll down and click on API. This will display the API Configuration page.
2. Create a New API Key
On the API Configuration page, locate the "API Keys" section.
Click the + Create API Key button.
A "Create New API Key" dialog box will appear.
Name: Enter a descriptive name for your API key (e.g., "Production API Key", "CRM Integration Key").
Expires At (optional): To set an expiry date for the key, click the calendar icon and select a date. If left blank, the key will not expire.
Click the Create button to generate your new API key. The key will now be listed under the "API Keys" section.
3. View API Documentation and Test Endpoints
In the "API Configuration" section, click the View API Docs & Test button.
You will be redirected to the interactive API documentation and testing interface.
Enter your newly generated API key into the designated field for authentication.
Authenticate your API key as prompted.
You can now use the interface to test all available API endpoints.
Tips
Always follow best practices and security guidelines when using and managing your API keys.
Consider setting an expiry date for API keys that are used for temporary integrations or specific projects to enhance security.
Name your API keys clearly to easily identify their purpose and associated integrations.
Conclusion
By following these steps, you can successfully create and test API keys in Realview Hub, enabling secure and efficient external integrations with your data.