Browse Source

Begin to introduce status

patch-1
Nico Schottelius 4 years ago
parent
commit
c64b2120b0
  1. 46
      README.md

46
README.md

@ -42,6 +42,12 @@ OR
```
## Usage: REST
- Use an existing token to connect to the service
- All REST based messages: JSON
### POST: /verify
Not sure if this one will be publicly available.
@ -75,11 +81,6 @@ OR
}
```
## Usage: REST
- Use an existing token to connect to the service
- All REST based messages: JSON
### POST /app/register
Register a new app. Returns an app ID.
@ -96,10 +97,21 @@ Request JSON object:
Response JSON object:
```
{
status: "OK",
appid: "UUID of your app",
}
```
OR
```
{
status: "FAIL",
error: "Reason for failure"
}
```
### GET /app
@ -115,17 +127,19 @@ Request JSON object:
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",
}
]
{
status: "OK",
apps: [
{
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

Loading…
Cancel
Save