summaryrefslogtreecommitdiffstats
path: root/protocol.txt
diff options
context:
space:
mode:
Diffstat (limited to 'protocol.txt')
-rw-r--r--protocol.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/protocol.txt b/protocol.txt
index 7e0f3c2..018006a 100644
--- a/protocol.txt
+++ b/protocol.txt
@@ -4,6 +4,16 @@ ACF2 HTTP Protocol
Load JavaScript client:
req: GET /
+Log in:
+req: POST /login
+ - body is a JSON object with username and password attributes
+resp: authentication token (in header as X-ACF-Auth-Token)
+ - use X-ACF-Auth-Token in the header of subsequent requests
+
+Log out:
+req: DELETE /login
+ X-ACF-Auth-Token: <token>
+
Start transaction:
req: POST /
resp: txn ID (in header as X-ACF-Transaction-ID)