REST API readme update 445/head
authorselfhoster <selfhoster@protonmail.com>
Thu, 28 Nov 2019 08:23:53 +0000 (19:23 +1100)
committerselfhoster <selfhoster@protonmail.com>
Thu, 28 Nov 2019 08:23:53 +0000 (19:23 +1100)
README.md

index b1024d23790874621a5affca90a8d6e34e0ccd14..3cffe81b448b4ce1933b4f33578f5d014d17538f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ With this app you can download songs, playlists and albums directly from Deezer'
 * Extensive set of options for a personalized experience
 * Server mode to launch the app headless
 * MOAR Optimizations
+* REST API
 
 ## Download
 All compiled downloads are on Telegram.<br>
@@ -53,6 +54,23 @@ To build the app for other OSs follow the table below
 | Linux              | `npm run dist:linux` |
 | macOS              | `npm run dist:macOS` |
 
+## REST API
+Add URLs to download queue via POST request
+
+Example Request:
+``` JSON
+POST http://localhost:1730/download/
+Content-Type: application/json
+
+{
+    "url": "https://www.deezer.com/album/115542362"
+}
+    or
+{
+    "url": ["https://www.deezer.com/track/812778162","https://www.deezer.com/playlist/708702152","https://www.deezer.com/track/813185722"]
+}
+```
+
 ## Disclaimer
 I am not responsible for the usage of this program by other people.<br/>
 I do not recommend you doing this illegally or against Deezer's terms of service.<br/>