Quix APIs Overview
Quix provides several APIs. These are:
- Streaming Reader API
- Portal API
While Quix Streams is the main client library for Quix, there are certain use cases where you need an alternative:
- The client uses a language that is not supported by Quix Streams (Quix Streams supports Python only)
- There are resource constraints which mean you can't run Quix Streams
- The nature of the client (for example, a web browser)
In these situations the Streaming Reader API can provide an alternative solution - for example, it can easily be accommodated in a modern web browser, or using most modern programming languages with a SignalR client.
Portal API is useful for automating processes normally carried out manually in Quix.
Each of these APIs is described in more detail in the following sections.
Comparing the APIs
Use cases for these APIs are shown in the following table:
| API | Interface | Purpose | Typical use case | Docs link |
|---|---|---|---|---|
| Streaming Reader API | SignalR (WebSockets and Long Polling) | Subscribe to a Quix topic | Web browser client, dashboard, command line client | Streaming Reader API |
| Portal API | HTTP (REST) | Automate Quix | Creating and monitoring deployments | Portal API |
Streaming Reader API
The Streaming Reader API enables you to stream data out of a Quix topic.
Streaming Reader uses Microsoft's SignalR technology, which provides both WebSockets and Long Polling, depending on client capabilities.
Portal API
The Portal API gives access to Quix, enabling you to automate your project deployment, management and monitoring. For example, you could build command line tools in any language with an HTTP interface available, to create, deploy, and monitor services.