Disclaimer¶ ↑
WARNING: All interfaces may be added, changed, or removed at any time.
Requirements¶ ↑
Using the API Beta requires a kiwi6.com account and registered application. Sign up for an account and start creating apps at the developer center - kiwi6.com/oauth/applications .
The Kiwi6 API Beta supports JSON over a RESTful interface.
Authentication¶ ↑
Kiwi6 authenticates using OAuth2. Here's the feature list we support from the OAuth 2 Spec:
-
Authorization Code Flow: tools.ietf.org/html/draft-ietf-oauth-v2-22#section-4.1
-
Access Token Scopes: tools.ietf.org/html/draft-ietf-oauth-v2-22#section-3.3
-
Resource Owner Password Credentials: tools.ietf.org/html/draft-ietf-oauth-v2-22#section-4.3
Example¶ ↑
Here is an example of using Resource Owner Password Credentials to authorize with Kiwi6.com
client = OAuth2::Client.new('APPLICATION_ID', 'APPLICATION_SECRET', :site => "https://kiwi6.com") access_token = client.password.get_token('[email protected]', 'secret') access_token.get "/api/v1/me.json"
Resources
Access levels
| Resource | Description |
|---|---|
| GET /api/v1/access_levels | Get a list of all access levels. |
Artists
| Resource | Description |
|---|---|
| GET /api/v1/artists | Get a list of all artists with pagination. |
| GET /api/v1/artists/:username | Retrieves artist object. |
Folders
| Resource | Description |
|---|---|
| GET /api/v1/folders/:id | Retrieves folder object. |
Tracks
| Resource | Description |
|---|---|
| GET /api/v1/tracks | Get a list of all tracks with optional search parameter. |
Uploads
| Resource | Description |
|---|---|
| GET /api/v1/myfiles | Shows files for the currently logged in user. |
| GET /api/v1/file/:id | Shows the specified file object. |
Users
| Resource | Description |
|---|---|
| GET /api/v1/users | Get a list of all users with pagination. |
| GET /api/v1/me | Retrieves user object for currently logged in user. |
| GET /api/v1/users/:username | Retrieves user object. |