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

5
api.md
View File

@@ -2,8 +2,7 @@
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:
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