Begin to describe JSON objects
This commit is contained in:
parent
8428b5fcbf
commit
33ea51fa76
1 changed files with 49 additions and 1 deletions
50
README.md
50
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/<id>
|
||||
{
|
||||
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
|
||||
|
||||
|
|
Loading…
Reference in a new issue