mattburchett/NadekoBot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #662 from miraai/dev

Browse Source 
Soundcloud API changes
This commit is contained in:
miraai 2016-09-26 01:56:21 +02:00 committed by GitHub
commit 2bb50caabf
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/JSON Explanations.md
View File

@ -17,7 +17,7 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl
"LOLAPIKEY": "", "LOLAPIKEY": "",
"TrelloAPPKey": "", "TrelloAPPKey": "",
"OsuAPIKey": "", "OsuAPIKey": "",
"CarbonKey": "", "CarbonKey": ""
} }
``` ```
####Required Parts ####Required Parts
@ -37,9 +37,10 @@ Setting up your API keys
+ You can get this api Key [here](https://console.developers.google.com/apis) + You can get this api Key [here](https://console.developers.google.com/apis)
+ **SoundCloudClientID** - Required to queue soundloud songs from sc links. + **SoundCloudClientID** - Required to queue soundloud songs from sc links.
+ You will need to create a new app [here](http://soundcloud.com/you/apps). **Please note you must be logged into SoundCloud** + You will need to create a new app [here](http://soundcloud.com/you/apps). **Please note you must be logged into SoundCloud**
+ You should come to a page that looks like this ![Imgur](http://i.imgur.com/RAZ2HDM.png)
+ Simply click Register a new application and enter a name. + Simply click Register a new application and enter a name.
+ After naming your app you will be brought to this page: ![Imgur](http://i.imgur.com/GH1gjKK.png) Copy the Client ID and click "save app" then paste the Client Id it into your `credentials.json` + You will need to fill out an application form to request access to Soundcloud API.
+ All requests for an API key must go through the review process, where applications will be reviewed on a case by case basis, in line with Soundcloud API Terms of Use. If your application is successful, you will receive an API key.
+ Copy the Client ID and click "save app" then paste the Client Id it into your `credentials.json`
+ **MashapeKey** - Required for Urban Disctionary, Hashtag search, and Hearthstone cards. + **MashapeKey** - Required for Urban Disctionary, Hashtag search, and Hearthstone cards.
+ You need to create an account on their [api marketplace](https://market.mashape.com/), after that go to `market.mashape.com/YOURNAMEHERE/applications/default-application` and press **Get the keys** in the top right corner. + You need to create an account on their [api marketplace](https://market.mashape.com/), after that go to `market.mashape.com/YOURNAMEHERE/applications/default-application` and press **Get the keys** in the top right corner.
+ Copy the key and paste it into `credentials.json` + Copy the key and paste it into `credentials.json`

2
docs/guides/Windows Guide.md
View File

@ -90,6 +90,8 @@ ________________________________________________________________________________
- Follow these steps on how to setup Soundcloud API key: - Follow these steps on how to setup Soundcloud API key:
- Go to [Soundcloud][Soundcloud]. - Go to [Soundcloud][Soundcloud].
- Enter a name for the app and create it. - Enter a name for the app and create it.
- You will need to fill out an application form to request access to Soundcloud API.
- All requests for an API key must go through the review process, where applications will be reviewed on a case by case basis, in line with Soundcloud API Terms of Use. If your application is successful, you will receive an API key.
- You will see a page with the title of your app, and a field labeled `Client ID`. Copy the ID. - You will see a page with the title of your app, and a field labeled `Client ID`. Copy the ID.
- In `credentials.json`, fill in `"SoundcloudClientID"` with the copied ID. - In `credentials.json`, fill in `"SoundcloudClientID"` with the copied ID.
- Restart your computer. - Restart your computer.