mirror of
https://gitlab.com/zwirbel/illucat.git
synced 2025-12-15 01:42:22 +01:00
Update api.md
This commit is contained in:
7
api.md
7
api.md
@@ -1,9 +1,8 @@
|
||||
# API
|
||||
Two API architectures are supported: WebSocket and REST.
|
||||
Both can be used with the same set of fields.
|
||||
Everything is propagated to the mesh network automatically.
|
||||
|
||||
Fields:
|
||||
Everything is propagated to the mesh network automatically.
|
||||
As everything can be controlled with topics, only two fields are required:
|
||||
- topic
|
||||
- payload
|
||||
|
||||
@@ -35,4 +34,6 @@ Example:
|
||||
#### Endpoints
|
||||
Content-Type: application/x-www-form-urlencoded
|
||||
POST /pixel/api
|
||||
Request: Form post with topic and payload as fields
|
||||
Response: 200 + JSON message that was used to notify the topics
|
||||
|
||||
Reference in New Issue
Block a user