|
1 | | -# Remote Two API Documentation |
| 1 | +# Remote Two/3 API Documentation |
2 | 2 |
|
3 | 3 | - [Remote Two user interface](remote-ui.md) |
| 4 | +- [Remote Two entities](entities/README.md) |
4 | 5 | - [Bluetooth HID peripheral support](bt/README.md) |
5 | 6 | - [Remote Two DNS-SD lookup](discovery.md) |
6 | 7 |
|
| 8 | +## Core API |
| 9 | + |
| 10 | +The Unfolded Circle Remote WebSocket & REST Core-APIs allow you to interact with the Unfolded Circle remote-core service |
| 11 | +and take full control of its features. |
| 12 | + |
| 13 | +The focus of the Core-APIs is to provide all functionality for the UI application and the web-configurator. |
| 14 | +The APIs are specialized for certain tasks, but otherwise contain the same functionality and data models. |
| 15 | + |
| 16 | +- The UCR REST Core-API adds: |
| 17 | + - Custom resource handling for uploading icons, images etc. |
| 18 | + - Installing custom remote-ui and web-configurator components. |
| 19 | + - Installing custom integration drivers. |
| 20 | + - User management and authentication handling. |
| 21 | +- The UCR WS Core-API adds: |
| 22 | + - Event subscription with asynchronous notifications. |
| 23 | + |
| 24 | +The Core-APIs may also be used by other external systems and integration drivers, if specific configuration or |
| 25 | +interaction features are required, which are not present in the UCR Integration-API. |
| 26 | + |
| 27 | +The API specifications are defined with [OpenAPI](https://swagger.io/specification/) & [AsyncAPI](https://www.asyncapi.com/) |
| 28 | +in YAML format. |
| 29 | + |
| 30 | +- [REST Core-API](https://unfoldedcircle.github.io/core-api/rest/) |
| 31 | +- [WebSocket Core-API](https://unfoldedcircle.github.io/core-api/ws/) |
| 32 | + |
7 | 33 | ## Integration API |
8 | 34 |
|
9 | | -- [Integration AsyncAPI YAML definition](https://unfoldedcircle.github.io/core-api/integration/) |
10 | | -- [Remote Two entities](entities/README.md) |
| 35 | +- [Integration AsyncAPI definition](https://unfoldedcircle.github.io/core-api/integration/) |
| 36 | +- View with [AsyncAPI Studio online tool](https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/unfoldedcircle/core-api/main/integration-api/UCR-integration-asyncapi.yaml). |
| 37 | + The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation in |
| 38 | + the browser. |
| 39 | + |
| 40 | +### Integration Driver |
| 41 | + |
11 | 42 | - [How to write an integration driver](integration-driver/write-integration-driver.md) |
12 | 43 | - [WebSockets handling](integration-driver/websocket.md) |
13 | 44 | - [Driver registration](integration-driver/driver-registration.md) |
|
0 commit comments