API version 3¶
The StreamOne platform provides an API via HTTP to communicate with the platform programatically. The API is organized into various command, and each command contains one or more actions. A command is a group of related actions, usually referring to a single entity in the platform. For example, the Item command consists of various actions for managing items in the platform, such as a Create action to create new items, and a View action to query the available items and view information about them.
Requests to API version 3 consist of a path, parameters and arguments. The path specifies which command and action must be executed. Parameters contain meta-information about the request, such as the API version, format of the output, and authentication information. Arguments contain information for the specific action which is executed, such as a set of filters to filter all items on, for the Item/View action. Both parameters and arguments are a set of key-value pairs. The set of available parameters is the same for all actions, but every action has its own set of available arguments.
The following documents provide more information about various aspects of the API.
- Requests and Responses
- There are a number of technicalities when issuing requests to the API and handling their responses, such as signing these requests with the proper credentials and providing the correct parameters. The details of performing a request are discussed in this document.
- Data types
- The arguments and response have fields containing data in various types. These pages describe the input and output formats used for these data types.
- This document contains an overview of all available commands and their actions, and includes specifications on the available arguments and responses of all actions.
- Every well-formed API call returns a status code to identify the result of the request. In most cases, this will be a status indicating that everything is OK. If something went wrong, the status indicates what went wrong.
- Every API action is secured by requiring a certain token to use that API action. This document contains an overview of the various tokens that are used to secure the API, and which actions are available by having each token assigned.