Including Authentication Headers in API Calls

If your API target device requires API authentication, an authentication header must be included in the API call.

• For Algo devices using the Standard authentication method, the device can automatically generate the Standard authentication header to simplify API calls.

• For Algo devices using the Basic authentication method, or non-Algo devices or services, the authentication header must be included manually in the Custom Headers .

Note

Third-party devices or services may use different authentication methods. Refer to their documentation and use the Custom Headers field to define the exact HTTP header names and values they require.

Including Standard Authentication Headers in API Calls to Algo Devices

You can include a standard authentication header in one of the following methods:

• Selecting a preset API command.

  Your device automatically includes a Standard authentication header.

  

• Using the Other API command type and choosing Algo Standard Authentication Headers, so the device automatically includes the standard authentication header.

  

Note

• You must enter the target Algo device’s RESTful API Password under Basic Settings → Features → Remote Device Settings → Remote Device RESTful API Password.

• If your API request targets more than one Algo device, all target devices must use the same RESTful API Password.

Setting the Target Algo Device’s RESTful API Password

To enable automatic generation of Standard authentication headers, you must specify the target Algo device’s RESTful API Password.

Note

If your API request targets more than one Algo device, all target devices must set the same RESTful API Password.

To specify the target Algo Device’s RESTful API Password:

1. Go to Basic Settings → Features → Remote Device Settings → Remote Device RESTful API Password.

   

2. Enter the target Algo device’s RESTful API Password.

   You can set the target Algo device’s RESTful API Password in its web interface under Advanced Settings → Admin → API Support.

Including Basic Authentication Headers in API Calls to Algo Devices

To include Basic authentication headers in API calls to Algo devices, use the Other API command type and enter the Basic authentication header in the Custom Headers field.

A basic authentication payload requires encoding the username (admin) and RESTful API Password using Base64.

You can use online tools such as the Basic Authentication Header Generator to generate the Base64 header.