REST APIs

An API (Application Programming Interface) enables programs to talk to each other. REST (Representational State Transfer) APIs are APIs that use HTTP requests in order to access and use data. Each HTTP request uses a unique URL, representing a different endpoint and each HTTP request that is sent is known as an API call.

The API endpoints represent the specific content that can be accessed at that location. This content is known as a resource and each resource is usually accessed based on additional details that are expressed through parameters and their values, also included in the API call. Resources can be returned in different formats, including JSON, HTML, audio files, or images.

The Surfsight API endpoints use HTTP request methods, which represent the actions that can be performed on or for those resources. Following are the methods supported by the Surfsight API:

  • GET — retrieves data
  • POST — creates new objects
  • PATCH — modifies existing objects
  • PUT — replaces existing objects
  • DELETE — deletes objects

The Surfsight API uses the OpenAPI specifications, which are the leading standards for REST APIs. See the OpenAPI definition file for more information.

Our API is divided into different groups of endpoints according to functionality. Use these APIs to perform different actions for your organization and devices, such as:

  • Receive information from your devices such as video footage, telematics information, and analytics.
  • Update the settings of your devices
  • Add new organizations
  • Remove users

See the API reference guide for full details about endpoints, parameters, and more.