Update API

README.md

@@ -1,10 +1,12 @@
 # Abstimm-ID Daemon
 Abstimm-ID Daemon - Dienst zum Erstellen und Abfragen von Abstimm-IDs (https://git.netzbegruenung.de/NB-Public/abstimm-id).
 
-# API
-## Abstim-ID abfragen
+Daemon for retrieving Argon2 hashes for user pseudonymisation in vote result lists.
+
+# API definition
+## Get vote ID
 ### REQUEST
-Abstimm-ID
+Request Headers - endpoint requires SSL client certificate
 ```http
 GET /get_ids HTTP/1.1
 Host: abstimmidd.netzbegruenung.de
@@ -14,10 +16,10 @@ Request Body
 ```javascript
 {
 "event_token": String,    // Token to identify event
-"round": Number,          // nth Ballot round
+"round": Number,          // nth vote round
 "user_names": [           // User names for which the Hash should be retrieved
     String,
-    [...]
+  [...]                 // repeat for all users for which the hash is needed
   ]
 }
 ```
@@ -25,10 +27,10 @@ Request Body
 ```javascript
 [
   {
-    "round": Number,
-    "user_name": String,
-    "hash": String
+    "round": Number,      // nth vote round
+    "user_name": String,  // name of a user
+    "hash": String        // Argon2 hash of user with round in Salt 
   },
-  [...]
+  [...]                   // repeats for all users listed in request
 ]
 ```