Available SDKs
PUBQ SDKs provide a consistent and idiomatic API across a variety of supported platforms and are the most feature-rich method of integrating PUBQ into an application. PUBQ SDKs contain a realtime and a REST interface, each of which can be used to satisfy different use cases.
Utilize this page to verify the supported SDK version for a specific feature. Please note that compatibility may differ between the realtime and REST interfaces, as well as across different SDKs.
RealTime and REST interfaces
The realtime interface is implemented using a PUBQ-defined protocol, with communication primarily over WebSockets. It enables devices and browsers to establish a continuous connection to PUBQ. A WebSocket connection to PUBQ is multiplexed, allowing multiple channels to share one connection. Additionally, it is bi-directional, enabling realtime messages to flow between the PUBQ service and devices/browser without resorting to inefficient techniques like HTTP polling. Realtime interface APIs are only applicable in environments that support asynchronous or event-driven IO.
The REST interface communicates with the PUBQ service using the HTTP protocol and operates in a stateless manner. It offers a convenient method to access the REST HTTP API and is designed for use by clients that do not necessitate real-time updates.
Deciding which interface to use depends on your application and use case.
PUBQ SDKs
The following table contains a list of common languages. It outlines the corresponding PUBQ SDK for each, along with a link to the relevant GitHub repository.
Language | Repository | Version | Notes |
---|---|---|---|
JavaScript | pubq-js | 1.0.10 | |
Node.js | pubq-js | 1.0.10 | |
Python | pubq-python | 1.2.1 | |
PHP | pubq-php | 1.0.1 | REST only |