API
ClearBlade Platform supports three native APIs:
- REST
- MQTT
- WebSockets
REST
REST API is the primary API for interacting with ClearBlade Cloud Platform and Edge Platform. OpenAPI Spec is used to maximize interoperability. REST API follows an OAuth 2 Model, explained here
There are two types of OpenAPI Specs:
- Lite (Recommended) - Contains all common endpoints for Users, Devices, and Edges
- Full - Contains all endpoints, including development environment endpoints
| OpenAPI Document | Spec (yaml) | Interactive Web Console |
|---|---|---|
| Lite | Spec | Interactive |
| Full | Spec | Interactive |
MQTT
ClearBlade provides an API for Authentication and Pub/Sub to the MQTT broker using MQTT protocol. The MQTT Broker is running on port 1883 and 1884(tls), for details see Messaging
Websockets
ClearBlade provides an API for Authentication and Pub/Sub to the MQTT broker using websockets. WebSockets Server runs on port 8903 and 8904(tls), see Messaging