API Settings

When you navigate to the Computers page, you will see a list of all available APIs. You will need to select an API from the list to manage an API. You can navigate to this page by selecting 'Computers' in the Navigation Panel and then clicking on your connected API.

Overview of API's

From the overview you can see the following information

• Status Colour

  • Green = The API is connected and you have an appropriate license.

  • Orange = The API is connected and you don't have an appropriate license.

  • Red = The API is not connected.

• Version

  • The version information of the API

Individual API settings

Once an API is selected, you can then click on the settings page for that API. You can alter the following information.

Name	Description
Computer Name	This is the name you will see as a description for the host computer on your Product Name Account. Defaults to the hostname.
Address	This is the URL of the API; the URL will be read from the local computer when the API is added to your account. A custom URL can be entered if required.
Port	This is the port the API will connect through. As default this is 43427 it should not normally be changed. This is for advanced use and complex networks with restrictions on which ports can be used. The port number used must match that of the connected API.

Once you have changed the above values, you must press the save button for these changes to take effect. You can press the revert button to return to the previous settings. You can press the remove API button to remove an API from your organisation. You can also deactivate the host computer associated with an API, meaning an API can only be connected to a local host machine.

Battery Services

If you have iTunes installed, Apple devices (macOS has the service pre installed for Apple devices) or an adb server running on your host, you will be able to obtain battery information on connected devices. You can adjust the settings of the battery update information by changing how often then battery information is obtained in intervals message in seconds. You can also alter the number of battery updates that can be run simultaneously.

API Logging

The API can generate logging information for all USB events and store information on what has happened, along with specific hardware information. This is useful for troubleshooting any issues encountered with the API and capturing any faults or issues. You should use full logging when obtaining logs for support unless otherwise instructed, once you have enabled logging and the event has taken place zip the logs to send through to Cambrionix for investigation. The zip logs button is currently only available in the desktop version.

Once you have obtained some logs you will need to send them to Cambrionix, ensure they are zipped so that if the files are large, they can still be sent over. If the files are still too large, then please use an online drive that Cambrionix support can have access to or send via a file transfer service.