Add Device - how to connect -> Connect to a shared device

Connect to a shared device

Summary

This page allows you to connect to an Awaberry Agentic device that has been shared with you. You will need an API Key and an API Secret provided by the person who shared the device. Once you enter these, the system will verify the project and allow you to add it to your list of connected devices.

Page Access

You can access this page by navigating to: /connect_steps_shared

Page Functionalities

Input Fields

  • API Key: This field is where you enter the unique API key provided to you for the shared device.
  • API Secret: This field is where you enter the secret code that accompanies the API key. This helps secure your connection.

Buttons

  • Continue: After entering your API Key and API Secret, click this button to search for and load the shared project details.
  • Back: If project details are displayed, this button allows you to return to the input form to enter different keys or re-enter existing ones.
  • Add shared device(s): Once the project details are successfully loaded and displayed, click this button to officially add the shared device to your Awaberry account.

Information Display Area

This area will show you what is happening in the background:

  • Loading Indicators: You may see spinning circles indicating that the system is processing your request.
  • Project Details: If the API Key and Secret are valid, the project's name, description, and a list of devices accessible through this shared project will be displayed here.
  • Error Messages: If there's an issue (e.g., incorrect keys, network problems, or the project doesn't allow connection), relevant error messages will appear here.

Scenario Executions

Possible usage steps within this page

1. Successfully connect a shared device

To connect a shared Awaberry Agentic device, follow these steps:

  1. Navigate to the "Connect to a shared device" page.
  2. In the "API Key" field, enter the API key provided to you.
  3. In the "API Secret" field, enter the API secret provided to you.
  4. Click the "Continue" button.
  5. The page will display the "Project Name", "Description", and a list of "Accessible Devices".
  6. Review the details and click the "Add shared device(s)" button.
  7. Upon successful addition, you will be redirected to your list of shared devices.

Possible errors which may occur on this page

1. Missing API Key

If you attempt to proceed without entering an API Key:

  • Error: An error message, "Please enter API key", will appear directly below the API Key field.
  • Reason: The system requires both the API Key and API Secret to identify and load project details.

2. Missing API Secret

If you attempt to proceed without entering an API Secret:

  • Error: An error message, "Please enter API secret", will appear directly below the API Secret field.
  • Reason: The system requires both the API Key and API Secret to identify and load project details.

3. Invalid API Key or Secret

If the API Key or API Secret you entered is incorrect or does not match a valid shared project:

  • Error: An error message, such as "Failed to load project: Exception: No project returned" or a similar message indicating a failure to find the project, will appear in the information display area.
  • Reason: The credentials provided do not correspond to an existing or shared project, or there was a problem communicating with the server.

4. Project does not allow terminal access

If you enter a valid API Key and Secret, but the project owner has not granted terminal access for the shared project:

  • Error: An error message, "Project does not allow terminal access", will appear in the information display area after you click "Continue".
  • Reason: The project's configuration explicitly prevents connections that require terminal access.

5. Failed to add shared device

After successfully loading a project, if there's an issue when trying to add it to your devices:

  • Error: An error message, "Failed to add shared device", will appear in the information display area.
  • Reason: This could be due to a network issue, a problem with your account, or a temporary service unavailability when trying to save the shared device information.

Up to User Manual Main Page