iot/sprocket-device-illucat
1
0
Fork 0
mirror of https://gitlab.com/zwirbel/illucat.git synced 2025-12-15 09:48:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update api.md

Browse Source
This commit is contained in:
Patrick Balsiger
2018-09-24 07:18:18 +00:00
parent 2dcbf22b09
commit 4c49d2660e
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
api.md
View File

@@ -1,9 +1,8 @@
# API # API
Two API architectures are supported: WebSocket and REST. Two API architectures are supported: WebSocket and REST.
Both can be used with the same set of fields. Both can be used with the same set of fields.
Everything is propagated to the mesh network automatically. Everything is propagated to the mesh network automatically.
As everything can be controlled with topics, only two fields are required:
Fields:
- topic - topic
- payload - payload
@@ -35,4 +34,6 @@ Example:
#### Endpoints #### Endpoints
Content-Type: application/x-www-form-urlencoded Content-Type: application/x-www-form-urlencoded
POST /pixel/api POST /pixel/api
Request: Form post with topic and payload as fields
Response: 200 + JSON message that was used to notify the topics