Permalink
Browse files

Dear API, you deserve a better documentation. KR.

  • Loading branch information...
1 parent e151a89 commit 0b502018ddb0b4e4fcd4ef5441f2cd86399d63e4 tchapi committed Nov 28, 2012
Showing with 2,884 additions and 470 deletions.
  1. +61 −470 README.md
  2. 0 { → consoles}/qobuz-apigee-wadl.xml
  3. +245 −0 endpoints/album/get.md
  4. +72 −0 endpoints/album/getFeatured.md
  5. +74 −0 endpoints/album/search.md
  6. +47 −0 endpoints/article/get.md
  7. +63 −0 endpoints/article/listLastRubrics.md
  8. +66 −0 endpoints/article/listRubrics.md
  9. +48 −0 endpoints/artist/get.md
  10. +59 −0 endpoints/artist/getSimilarArtists.md
  11. +54 −0 endpoints/artist/search.md
  12. +40 −0 endpoints/favorite/create.md
  13. +40 −0 endpoints/favorite/delete.md
  14. +75 −0 endpoints/favorite/getUserFavorites.md
  15. +39 −0 endpoints/genre/get.md
  16. +87 −0 endpoints/genre/list.md
  17. +40 −0 endpoints/label/get.md
  18. +70 −0 endpoints/label/list.md
  19. +39 −0 endpoints/playlist/addTracks.md
  20. +52 −0 endpoints/playlist/create.md
  21. +36 −0 endpoints/playlist/delete.md
  22. +39 −0 endpoints/playlist/deleteTracks.md
  23. +149 −0 endpoints/playlist/get.md
  24. +68 −0 endpoints/playlist/getPublicPlaylists.md
  25. +75 −0 endpoints/playlist/getUserPlaylists.md
  26. +36 −0 endpoints/playlist/subscribe.md
  27. +36 −0 endpoints/playlist/unsubscribe.md
  28. +54 −0 endpoints/playlist/update.md
  29. +36 −0 endpoints/playlist/updatePlaylistsPosition.md
  30. +42 −0 endpoints/playlist/updateTracksPosition.md
  31. +72 −0 endpoints/purchase/getArticles.md
  32. +180 −0 endpoints/purchase/getUserPurchases.md
  33. +132 −0 endpoints/search/getBestMatch.md
  34. +47 −0 endpoints/search/getResultCount.md
  35. +173 −0 endpoints/search/getResults.md
  36. +34 −0 endpoints/template.md
  37. +75 −0 endpoints/track/get.md
  38. +41 −0 endpoints/track/getFileUrl.md
  39. +130 −0 endpoints/track/search.md
  40. +158 −0 endpoints/user/login.md
View
531 README.md

Large diffs are not rendered by default.

Oops, something went wrong.
File renamed without changes.
View
@@ -0,0 +1,245 @@
+# Album Service : get
+
+ GET album/get
+
+## Description
+
+Return the metadata for an album.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `album_id` - _required_ : The album ID to fetch the metadata of.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/album/get?app_id=100000000&album_id=0060252780907
+
+**Return**
+
+```json
+{
+ "id": "0060252780907",
+ "title": "Watch The Throne",
+ "released_at": 1347228000,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0060/0060252780907_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0060/0060252780907_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0060/0060252780907_50.jpg",
+ "back": null
+ },
+ "artist": {
+ "id": 62054,
+ "name": "Jay-Z"
+ },
+ "label": {
+ "id": 17119,
+ "name": "Universal Music Division Barclay"
+ },
+ "genre": {
+ "id": 127,
+ "name": "Soul Funk Rap"
+ },
+ "description": "Lorsque les deux poids lourds du rap contemporain se retrouvent sur un même ring, le match ne peut qu’être surpuissant. Et ce <i>Watch The Throne</i> l’est ! Une fois oubliés le strass et les paillettes de cette double tête d’affiche, reste un bel exercice de soul urbaine et de hip hop futuriste. La rime est riche, la production éclectique dans ses textures sonores et aucun des deux ne cherche à tirer à lui la couverture. Un vrai festin pour les fans de hip hop.",
+ "url": "http://www.qobuz.com/album/watch-the-throne-jay-z-kanye-west/0060252780907",
+ "awards": [
+ {
+ "slug": "pitchfork",
+ "award_slug": "pitchfork",
+ "name": "Pitchfork: Best New Music",
+ "awarded_at": 1312149600,
+ "updated_at": "2012-02-17 10:49:50"
+ },
+ {
+ "slug": "les-inrocks",
+ "award_slug": "selection_inrocks",
+ "name": "Sélection Les Inrocks",
+ "awarded_at": 1312149600,
+ "updated_at": "2012-02-17 10:49:50"
+ }
+ ],
+ "goodies": [
+ {
+ "file_format_id": 21,
+ "name": "Livret numérique",
+ "description": "Jay-Z & Kanye West - Watch The Throne",
+ "url": "http://www.qobuz.com/goodies/000014413.swf"
+ }
+ ],
+ "tracks": {
+ "offset": 0,
+ "limit": null,
+ "total": 12,
+ "items": [
+ {
+ "id": 3809940,
+ "title": "No Church In The Wild (Album Version (Explicit))",
+ "track_number": 1,
+ "media_number": 1,
+ "duration": 272,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809941,
+ "title": "Lift Off (Album Version (Explicit))",
+ "track_number": 2,
+ "media_number": 1,
+ "duration": 266,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809942,
+ "title": "Ni**as In Paris (Album Version (Explicit))",
+ "track_number": 3,
+ "media_number": 1,
+ "duration": 219,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809943,
+ "title": "Otis (Album Version (Explicit))",
+ "track_number": 4,
+ "media_number": 1,
+ "duration": 178,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809944,
+ "title": "Gotta Have It (Album Version (Explicit))",
+ "track_number": 5,
+ "media_number": 1,
+ "duration": 140,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809945,
+ "title": "New Day (Album Version (Explicit))",
+ "track_number": 6,
+ "media_number": 1,
+ "duration": 272,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809946,
+ "title": "That's My Bitch (Album Version (Explicit))",
+ "track_number": 7,
+ "media_number": 1,
+ "duration": 202,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809947,
+ "title": "Welcome To The Jungle (Album Version (Explicit))",
+ "track_number": 8,
+ "media_number": 1,
+ "duration": 174,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809948,
+ "title": "Who Gon Stop Me (Album Version (Explicit))",
+ "track_number": 9,
+ "media_number": 1,
+ "duration": 256,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809949,
+ "title": "Murder To Excellence (Album Version (Explicit))",
+ "track_number": 10,
+ "media_number": 1,
+ "duration": 300,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809950,
+ "title": "Made In America (Album Version (Explicit))",
+ "track_number": 11,
+ "media_number": 1,
+ "duration": 292,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809951,
+ "title": "Why I Love You (Album Version (Explicit))",
+ "track_number": 12,
+ "media_number": 1,
+ "duration": 201,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ }
+ ]
+ }
+}
+```
@@ -0,0 +1,72 @@
+# Album Service : getFeatured
+
+ GET album/getFeatured
+
+## Description
+
+Return album recommandations by type and/or genre.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `type` - _optional_ : The type of recommandations to fetch: `best-sellers`, `new-releases`, `press-awards`, `editor-picks`, `most-featured`
+> + `genre_id` - _optional_ : The genre ID to filter the recommandations by.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/album/getFeatured?app_id=100000000&type=new-releases&genre_id=64&limit=2
+
+**Return**
+
+```json
+{
+ "albums": {
+ "offset": 0,
+ "limit": 2,
+ "total": 34,
+ "items": [
+ {
+ "id": "0801061023034",
+ "title": "Until The Quiet Comes",
+ "released_at": 1350856800,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0801/0801061023034_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0801/0801061023034_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0801/0801061023034_50.jpg"
+ },
+ "artist": {
+ "id": 291266,
+ "name": "Flying Lotus"
+ }
+ },
+ {
+ "id": "5051083066389",
+ "title": "Rave Age",
+ "released_at": 1352070000,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/5051/5051083066389_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/5051/5051083066389_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/5051/5051083066389_50.jpg"
+ },
+ "artist": {
+ "id": 396611,
+ "name": "Vitalic"
+ }
+ }
+ ]
+ }
+}
+```
View
@@ -0,0 +1,74 @@
+# Album Service : search
+
+ GET album/search
+
+## Description
+
+Search for albums by name. Return album matches sorted by relevance.
+
+> NB : This method is a common wrapper for the search/getResults method for `type=albums`
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `query` - _required_ : The term to search for.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/album/search?app_id=100000000&query=John%20Cage&limit=2
+
+**Return**
+
+```json
+{
+ "query": "John Cage",
+ "albums": {
+ "limit": 2,
+ "offset": 0,
+ "total": 243,
+ "items": [
+ {
+ "id": "3760058360279",
+ "title": "John Cage : Sonatas & Interludes",
+ "released_at": 1335132000,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/3760/3760058360279_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/3760/3760058360279_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/3760/3760058360279_50.jpg"
+ },
+ "artist": {
+ "id": null,
+ "name": "Cédric Pescia"
+ }
+ },
+ {
+ "id": "5029365928427",
+ "title": "Music for an Aquatic Ballet - Music for Carillon n°6",
+ "released_at": 1341871200,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/5029/5029365928427_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/5029/5029365928427_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/5029/5029365928427_50.jpg"
+ },
+ "artist": {
+ "id": null,
+ "name": "Roberto Fabbriciani"
+ }
+ }
+ ]
+ }
+}
+```
Oops, something went wrong.

0 comments on commit 0b50201

Please sign in to comment.