Add API definition

This commit is contained in:
Sven Seeberg 2020-10-20 14:10:57 +02:00
parent 73b6c2de78
commit 65bb780794
Signed by: sven.seeberg
GPG key ID: 29559DD5A83806B5

View file

@ -1,3 +1,34 @@
# abstimmidd
# Abstimm-ID Daemon
Abstimm-ID Daemon - Dienst zum Erstellen und Abfragen von Abstimm-IDs (https://git.netzbegruenung.de/NB-Public/abstimm-id).
Abstimm-ID Daemon - Dienst zum Erstellen von Abstimm-IDs (https://git.netzbegruenung.de/NB-Public/abstimm-id)
# API
## Abstim-ID abfragen
### REQUEST
Abstimm-ID
```http
GET /get_ids HTTP/1.1
Host: abstimmidd.netzbegruenung.de
Content-Type: application/json
```
Request Body
```javascript
{
"event_token": String, // Token to identify event
"round": Number, // nth Ballot round
"user_names": [ // User names for which the Hash should be retrieved
String,
[...]
]
}
```
### RESPONSE
```javascript
[
{
"round": Number,
"user_name": String,
"hash": String
},
[...]
]
```