Create api.md

mpromonet · Jan 14, 2023 · a3c5a1e · a3c5a1e
1 parent 28d2cbc
commit a3c5a1e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,11 @@
+# api
+
+The WebRTC signaling is implemented through HTTP requests:
+
+ - /api/call   : send offer and get answer
+ - /api/hangup : close a call
+
+ - /api/addIceCandidate : add a candidate
+ - /api/getIceCandidate : get the list of candidates
+
+The list of HTTP API is available using /api/help.