Settings Manual

configure API keys

Table of Contents

1. Accessing the Settings Window

2. API Key Management

3. Setting the HyperEdge URL

---

Accessing the Settings Window

To access the HyperEdge Settings Window:

• Open the HyperEdge application.

• Navigate to the top menu and select the Settings option.

• The HyperEdge Settings Window will appear with API Key and HyperEdge URL configuration.

API Key Management

Viewing and Updating the API Key:

• The API Key field displays the current key used by the application to authenticate with services.

• To update the API Key:

  • Click into the API Key field.

  • Enter the new API Key.

  • Click Check API Key to verify the new key’s validity.

  • The system will confirm if the new API Key is accepted or provide an error if the key is invalid.

Security Note: Ensure that the API Key remains confidential to prevent unauthorized access to your services.

Setting the HyperEdge URL

Configuring the Service Endpoint:

• The HyperEdge URL field allows you to specify the endpoint where the HyperEdge services are hosted.

• To update the HyperEdge URL:

  • Enter the new URL into the HyperEdge URL field.

  • This URL should be the base path that the HyperEdge application uses to send requests.

Connectivity Check:

• After setting a new URL, it's important to verify connectivity.

• Click Check API Key after setting the URL to ensure that the application can reach the HyperEdge services at the new endpoint.