Considerations¶
das-Peak Streaming Socket.IO Channel exposes a Socket.IO based API that enables low-latency, bidirectional and event-based communication between a client and das-Peak Streaming. Users can consume this API when they aim to perform real time authentication operations without implementing long-polling mechanisms. It is advisable to use Socket.IO Signalling Channel whenever possible.
There exists multiple Socket.IO client implementations in many different programming languages which can be perfectly used to connect to Socket.IO Channel.
Compatibility¶
This API is designed to be backwards-compatible (whenever possible). An API is said to be backwards-compatible if a client written against a previous version of the API will keep working against future ones.
The following changes are considered backwards compatible:
- Adding new resources (on new URIs)
- Adding new optional request form fields or JSON properties
- Adding new optional query parameters
- Adding new JSON properties to existing API responses
- Changing the order of JSON properties on existing API responses
- Changing the order of items on JSON object or array properties (unless the documentation states they are ordered)
- Adding new optional headers in requests
- Adding new headers in responses
The following changes are considered backwards incompatible (breaking changes):
- Removing API resources
- Renaming API resources (changing URIs)
- Adding new required request form fields, JSON properties, query parameters or headers
- Making any existing optional request form fields, JSON properties, query parameters or headers required
- Removing existing request form fields, JSON properties, query parameters or headers
- Changing the meaning of existing request form fields, JSON properties, query parameters or headers
- Adding new request form fields, JSON properties, query parameters or headers that alter the meaning of existing ones
- Changing the type of existing request form fields or JSON properties (from string to number for example)
- Changing the format or maximum length of existing opaque string properties with documented conflicting constraints
Backwards incompatible (breaking) changes may be introduced by bumping the API version, as explained on the Versioning section. In this scenario, previous versions of the API may be marked as deprecated and stop receiving new features. Should this happen, these old versions will be available for some agreed period of time, until they are eventually removed.
Veridas will announce in advance this deprecation and removal process (also called sunsetting) to ensure that users have enough time to migrate to the newest version of the API without causing any downtime or service disruptions.
Authentication¶
This service sits behind a gateway responsible for authenticating end users and routing requests. The authentication method is OAuth 2.0 Client Credentials Grant.
Versioning¶
The API version will be included in the URL, after the base url and before the endpoint:
https://<base_url>/<service>/**v{number:integer}**/<endpoint>
Non-backwards compatible changes will cause a version increment. As of now, the API only supports the v1 version.