Note: The VSSL REST API is no longer being actively supported.
An application programming interface (API) is a set of subroutine definitions, protocols, and tools for building application software. Simply put, an API is a set of clearly defined methods of communication between various software components.
Representational State Transfer (REST) is an architectural style that defines a set of constraints and properties based on HTTP. REST web services allow the requesting systems to access and manipulate textual representations of web resources by using a uniform and predefined set of stateless operations.
Under the hood, this is a TCP/IP control interface where the TCP/IP commands are sent as HTTP requests.
Every major coding library has simple methods for communicating with REST APIs. Natively VSSL doesn’t implement a REST API on its products. However, we have packaged a VSSL REST API in a Ubuntu snap container that can be installed on many Linux platforms. With the VSSL REST API users can enjoy:
- Easier integration: Integrating with the VSSL is a complicated process of maintaining multiple IP connections, monitoring events, and multiple connections.
- Better reliability: The VSSL agent is a self-updating package that is officially maintained by VSSL. We test all methods to ensure reliability with VSSL products.
- Better support for new features: When VSSL rolls out new features or necessary bug fixes, the VSSL agent is automatically updated by VSSL in conjunction with new FW, so your integrations won’t break.
For a complete description of the VSSL REST API and how it can be used, please see our documentation.