From 33ea51fa76e4cd15fcfaf253bf242c1c04ba0bda Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Fri, 26 Oct 2018 19:31:18 +0200 Subject: [PATCH] Begin to describe JSON objects --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ff9076..4c7c3cf 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,63 @@ We are using Register a new app. Returns an app ID. +Request JSON object: + +{ + appid: "your-app-uuid", + token: "current time based token" + name: "name of your web app" +} + +Response JSON object: + +{ + appid: "UUID of your app", +} + + ### GET /app List all registered apps for the current user. +Request JSON object: -### GET /app/ +{ + appid: "your-app-uuid", + token: "current time based token" +} + +Response JSON object: + +[ + { + name: "name of your web app" + appid: "UUID of your app", + }, + { + name: "name of your second web app" + appid: "UUID of your second app", + } +] + + +### GET /app/UUID Get seed for APP to be used as a token +Request JSON object: + +{ + appid: "your-app-uuid", + token: "current time based token" +} + +Response JSON object: + +{ + seed: "seed of your app" +} + ## Usage: OTP