Objective
This tutorial explains how to create a new API key in Research Logix to enable interaction with its data for internal or external applications. By following these steps, users can generate and configure API keys securely.
Key Steps
-
Access the API Keys Section
-
Log in to Research Logix as an administrative user.
-
Navigate to API and Access Keys.
-
-
Create a New API Key
-
Click Create New Key.
-
Enter a Key Name that reflects its intended purpose (e.g., external website service calls).
-
Provide an optional Key Description to further clarify its use.
-
Click Create API Key.
-
-
Retrieve API Key and Secret
-
Upon creation, you will receive a Key and Secret.
-
These credentials are required to connect to the Research Logix API securely.
-
-
Assign Services to the API Key
-
Click Manage to view the list of available API services.
-
Select the services that the API key should access (e.g., Members and Publications).
-
Click Save to apply the selected services.
-
-
Confirm API Key Access
-
Verify that the assigned services are listed under the API key.
-
The key is now ready to be used for API interactions.
-
Cautionary Notes
-
Store the API key and secret securely; they are required for authentication.
-
Only assign necessary services to minimize security risks.
-
If an API key is no longer needed, revoke access promptly to prevent unauthorized use.
Tips for Efficiency
-
Use descriptive key names to easily identify their purpose later.
-
Assign only the required services to optimize security and performance.
-
Regularly review active API keys and remove any that are no longer in use.
-
Keep documentation of API keys and their intended functions for internal reference.
Link to Loom
https://www.loom.com/share/0920a747aeff4b1797f2c06e7b92127f?sid=3b4e3505-90e8-4b5b-9478-542082aa9bca