Updated Version 1.0 API (markdown)
+68
-3
@@ -1,5 +1,5 @@
|
|||||||
# Version 1.0 API
|
# Version 1.0 API
|
||||||
This page contains API documentation regarding version 1.0 if the API. For the sake of the examples I will use
|
This page contains API documentation regarding version 1.0 if the API. For the sake of the examples I will use icarus-demo.com as the hostname and https. Though if you are using Icarus without a host name you can merely provide the IP address coupled with the port number.
|
||||||
|
|
||||||
## API Categories
|
## API Categories
|
||||||
* Authentication
|
* Authentication
|
||||||
@@ -10,9 +10,74 @@ This page contains API documentation regarding version 1.0 if the API. For the s
|
|||||||
* Year
|
* Year
|
||||||
* Cover art
|
* Cover art
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
### Retrieving token
|
||||||
|
**URI**: https://icarus-demo.com/api/v1/login
|
||||||
|
**Method**: Post
|
||||||
|
**Content type**: application/json
|
||||||
|
**Request body**:
|
||||||
|
```Json
|
||||||
|
{
|
||||||
|
"username":"usr",
|
||||||
|
"password":"secret"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
**Response body**:
|
||||||
|
```Json
|
||||||
|
{
|
||||||
|
"id":1,
|
||||||
|
"username":"usr",
|
||||||
|
"token":"dsfsdfnisdnosnfwefh923hr329hf29fb293fhn20jf20f",
|
||||||
|
"token_type":"Bearer",
|
||||||
|
"expiration":8000
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Songs
|
## Songs
|
||||||
|
|
||||||
### Uploading Songs
|
### Uploading Song
|
||||||
|
**URI**: https://icarus-demo.com/api/v1/song/data
|
||||||
**Method**: Post
|
**Method**: Post
|
||||||
**Content type**: multipart/form-data
|
**Content type**: multipart/form-data
|
||||||
**Authorization**: Bearer ``token``
|
**Authorization**: Bearer ``token``
|
||||||
|
**File**: @file=/path/to/song/you/wish/to/upload.mp3
|
||||||
|
|
||||||
|
### Downloading Song
|
||||||
|
**URI**: https://icarus-demo.com/api/v1/song/data/id
|
||||||
|
**Method**: Get
|
||||||
|
**Authorization**: Bearer ``token``
|
||||||
|
|
||||||
|
### Delete Song
|
||||||
|
**URL**: https://icarus-demo.com/api/v1/song/id
|
||||||
|
**Method**: Delete
|
||||||
|
**Authorization**: Bearer ``token``
|
||||||
|
|
||||||
|
### Updating Song Metadata
|
||||||
|
**URI**: https://icarus-demo.com/api/v1/song/id
|
||||||
|
**Method**: Update
|
||||||
|
**Authorization**: Bearer ``token``
|
||||||
|
**Request body**:
|
||||||
|
```Json
|
||||||
|
{
|
||||||
|
"title":"updated title",
|
||||||
|
"artist":"updated artist",
|
||||||
|
"album":"updated album",
|
||||||
|
"genre":"updated genre",
|
||||||
|
"year":"updated year"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Retrieve Song Metadata
|
||||||
|
**URI**: https://icarus-demo.com/api/v1/song/id
|
||||||
|
**Method**: Get
|
||||||
|
**Authorization**: Bearer ``token``
|
||||||
|
**Response body**:
|
||||||
|
```Json
|
||||||
|
{
|
||||||
|
"title":"Song Title",
|
||||||
|
"artist":"Artist or Band",
|
||||||
|
"album":"Album Name",
|
||||||
|
"genre":"Genre",
|
||||||
|
"year":1970
|
||||||
|
}
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user