phoenix/icarus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 33 Wiki Activity

Updated Version 1.0 API (markdown)

Kun Deng
2019-07-18 19:37:56 -04:00
parent e1b30f6201
commit f2602265af
1 changed files with 0 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Version-1.0-API.md
-47
@@ -10,53 +10,6 @@ This page contains API documentation regarding version 1.0 if the API. For the s
* Year
* Cover art
## Authentication
### Retrieving token
**URI**: https://icarus-demo.com/api/v1/login
**Method**: Post
**Content type**: application/json
**Request body**:
```Json
{
"username" : "phoenix",
"password" : "Flame"
}
```
**Response body**:
```Json
{
"id" : 1,
"username" : "phoenix",
"token" : "dsfsdfnisdnosnfwefh923hr329hf29fb293fhn20jf20f",
"token_type" : "Bearer",
"expiration" : 8000
}
```
### Register
**URI**: https://icarus-demo.com/api/v1/register
**Method**: Post
**Content type**: application/json
**Request body**:
```Json
{
"first_name" : "Atman",
"last_name" : "Heron",
"username" : "ateron",
"nickname" : "heron",
"password" : "secret",
"email" : "elysium@aaru.org",
"phone_number" : "(789) 555-841"
}
```
**Response body**:
```Json
{
"username" : "ateron",
"successfully_registered" : true,
"message" : "User successfully registered"
}
```
## Songs
### Uploading Song