115 lines
4.0 KiB
Markdown
115 lines
4.0 KiB
Markdown
# SoundCloud PHP API Wrapper
|
|
|
|
## Introduction
|
|
|
|
A wrapper for the SoundCloud API written in PHP with support for authentication using [OAuth 2.0](http://oauth.net/2/).
|
|
|
|
The wrapper got a real overhaul with version 2.0. The current version was written with [PEAR](http://pear.php.net/) in mind and can easily by distributed as a PEAR package.
|
|
|
|
## Getting started
|
|
|
|
Check out the [getting started](https://github.com/mptre/php-soundcloud/wiki/OAuth-2) wiki entry for further reference on how to get started. Also make sure to check out the [demo application](https://github.com/mptre/ci-soundcloud) for some example code.
|
|
|
|
|
|
## Examples
|
|
|
|
The wrapper includes convenient methods used to perform HTTP requests on behalf of the authenticated user. Below you'll find a few quick examples.
|
|
|
|
Ofcourse you need to handle the authentication first before being able to request and modify protect resources as demonstrated below. Therefor I refer to the [demo application](https://github.com/mptre/ci-soundcloud) which got some example code on how to handle authentication.
|
|
|
|
### GET
|
|
|
|
<pre><code>try {
|
|
$response = json_decode($soundcloud->get('me'), true);
|
|
} catch (Services_Soundcloud_Invalid_Http_Response_Code_Exception $e) {
|
|
exit($e->getMessage());
|
|
}</code></pre>
|
|
|
|
### POST
|
|
|
|
<pre><code>$comment = <<<EOH
|
|
<comment>
|
|
<body>Yeah!</body>
|
|
</comment>
|
|
EOH;
|
|
|
|
try {
|
|
$response = json_decode(
|
|
$soundcloud->post(
|
|
'tracks/1/comments',
|
|
$comment,
|
|
array(CURLOPT_HTTPHEADER => array('Content-Type: application/xml'))
|
|
),
|
|
true
|
|
);
|
|
} catch (Services_Soundcloud_Invalid_Http_Response_Code_Exception $e) {
|
|
exit($e->getMessage());
|
|
}</code></pre>
|
|
|
|
### PUT
|
|
|
|
<pre><code>$track = <<<EOH
|
|
<track>
|
|
<downloadable>true</downloadable>
|
|
</track>
|
|
EOH;
|
|
|
|
try {
|
|
$response = json_decode(
|
|
$soundcloud->put(
|
|
'tracks/1',
|
|
$track,
|
|
array(CURLOPT_HTTPHEADER => array('Content-Type: application/xml'))
|
|
),
|
|
true
|
|
);
|
|
} catch (Services_Soundcloud_Invalid_Http_Response_Code_Exception $e) {
|
|
exit($e->getMessage());
|
|
}</code></pre>
|
|
|
|
### DELETE
|
|
|
|
<pre><code>try {
|
|
$response = json_decode($soundcloud->delete('tracks/1'), true);
|
|
} catch (Services_Soundcloud_Invalid_Http_Response_Code_Exception $e) {
|
|
exit($e->getMessage());
|
|
}</code></pre>
|
|
|
|
### DOWNLOAD TRACK
|
|
|
|
<pre><code>try {
|
|
$track = $soundcloud->download(1337);
|
|
} catch (Services_Soundcloud_Invalid_Http_Response_Code_Exception $e) {
|
|
exit($e->getMessage());
|
|
}
|
|
|
|
// do something clever with $track. Save to file perhaps?</code></pre>
|
|
|
|
## Feedback and questions
|
|
|
|
Found a bug or missing a feature? Don't hesitate to create a new issue here on GitHub. Or contact me [directly](https://github.com/mptre).
|
|
|
|
Also make sure to check out the official [documentation](https://github.com/soundcloud/api/wiki/) and the join [Google Group](https://groups.google.com/group/soundcloudapi?pli=1) in order to stay updated.
|
|
|
|
## License
|
|
|
|
Copyright (c) 2011 Anton Lindqvist
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|