The REST API is an application programming interface that provides an interface that external systems can use to access Fleet Monitoring plugin features.
Tip: You can configure the REST API at the AVL plugin
level to allow third-party software to integrate with the plugin.
| Setting name | Description |
|---|---|
| REST API | |
| Authentication type | Select your authentication type from OAuth or basic authentication. OAuth is more
secure. IMPORTANT: Basic authentication is required
if geofence monitoring is enabled in the Vehicle Monitoring while the Fleet Monitoring plugin is used as the source of geofences.
|
| API path name prefix | Select the characters that precede the name used for all paths served by the REST API. |
| Web server allow self-signed certificate | Select this setting if the Web server role lacks a valid security certificate. Check the certificate validity using the link on the Web server role Properties page. If your browser shows an insecure connection, install a valid certificate. |
| API documentation | When selected, an endpoint to access the API documentation is enabled and a link to this API appears. This feature should be disabled in production environments. |