diff options
| -rw-r--r-- | index.rst | 4 | ||||
| -rw-r--r-- | json/account.rst | 28 | ||||
| -rw-r--r-- | json/authentication.rst | 12 | ||||
| -rw-r--r-- | json/bookmarks.rst | 12 | ||||
| -rw-r--r-- | json/errorcodes.rst | 4 | ||||
| -rw-r--r-- | json/implementations.rst | 4 | ||||
| -rw-r--r-- | json/index.rst | 13 | ||||
| -rw-r--r-- | json/methods.rst | 3 | ||||
| -rw-r--r-- | json/partners.rst | 4 | ||||
| -rw-r--r-- | json/play.rst | 15 | ||||
| -rw-r--r-- | json/stations.rst | 55 |
11 files changed, 154 insertions, 0 deletions
@@ -1,6 +1,10 @@ Unofficial Pandora API documentation ==================================== + +.. index:: + single: Contributing + This documentation project replaces the Wiki_ hosted by wikia_, which got taken down by Pandora_ (`read more`_). It aims to provide language-independent documentation of Pandora’s `proprietary API`_. diff --git a/json/account.rst b/json/account.rst index bec43e1..7eaa8f2 100644 --- a/json/account.rst +++ b/json/account.rst @@ -1,6 +1,10 @@ Account ======= + +.. index:: + single: user.validateUsername + .. _user-validateUsername: Validate username @@ -22,6 +26,10 @@ This method can be used before authenticating a user with isValid,boolean, isUnique,boolean, + +.. index:: + single: user.createUser + .. _user-createUser: Create new account @@ -84,6 +92,10 @@ The following settings are currently read/writeable: facebookSettingChecksum,boolean, userInitiatedChange,boolean, + +.. index:: + single: user.getSettings + .. _user-getSettings: Retrieve @@ -98,6 +110,10 @@ Retrieve See :ref:`settingkeys` for return values. + +.. index:: + single: user.changeSettings + .. _user-changeSettings: Modify @@ -115,6 +131,10 @@ body. .. TODO response? + +.. index:: + single: user.emailPassword + .. _user-emailPassword: Recover password @@ -129,6 +149,10 @@ Recover password .. TODO response? + +.. index:: + single: user.canSubscribe + .. _user-canSubscribe: Get subscriber status @@ -160,6 +184,10 @@ Can be useful to determine which :ref:`Partner password<partners>` to use. } } + +.. index:: + single: user.getUsageInfo + .. _user-getUsageInfo: Usage info diff --git a/json/authentication.rst b/json/authentication.rst index 0fff225..28fdf00 100644 --- a/json/authentication.rst +++ b/json/authentication.rst @@ -5,6 +5,10 @@ Authentication Authentication is divided into two steps: Partner and user login. + +.. index:: + single: test.checkLicensing + .. _test-checkLicensing: Check licensing @@ -21,6 +25,10 @@ enforces this restriction. The request has no parameters. isAllowed,bool, + +.. index:: + single: auth.partnerLogin + .. _auth-partnerLogin: Partner login @@ -91,6 +99,10 @@ Code Description 1002 INVALID_PARTNER_LOGIN. Invalid partner credentials. ==== ============ + +.. index:: + single: auth.userLogin + .. _auth-userLogin: User login diff --git a/json/bookmarks.rst b/json/bookmarks.rst index 13a917e..f8023e4 100644 --- a/json/bookmarks.rst +++ b/json/bookmarks.rst @@ -3,6 +3,10 @@ Bookmarks Users can bookmark artists or songs. + +.. index:: + single: user.getBookmarks + .. _user-getBookmarks: Retrieve bookmarks @@ -65,6 +69,10 @@ The request has no parameters. } + +.. index:: + single: bookmark.addArtistBookmark + .. _bookmark-addArtistBookmark: Add artist bookmark @@ -108,6 +116,10 @@ Add artist bookmark } } + +.. index:: + single: bookmark.addSongBookmark + .. _bookmark-addSongBookmark: Add song bookmark diff --git a/json/errorcodes.rst b/json/errorcodes.rst index edd14bd..0603ec1 100644 --- a/json/errorcodes.rst +++ b/json/errorcodes.rst @@ -1,3 +1,7 @@ +.. index:: + single: Error codes + + List of error codes =================== diff --git a/json/implementations.rst b/json/implementations.rst index 6e3ff68..bdb4bad 100644 --- a/json/implementations.rst +++ b/json/implementations.rst @@ -1,3 +1,7 @@ +.. index:: + single: Implementations + + =============== Implementations =============== diff --git a/json/index.rst b/json/index.rst index 28767b3..0fbdf6c 100644 --- a/json/index.rst +++ b/json/index.rst @@ -1,6 +1,10 @@ JSON API v5 =========== + +.. index:: + single: API Endpoints + The current JSON API version is 5. Two different endpoints are available: - http://tuner.pandora.com/services/json/ @@ -9,6 +13,11 @@ The current JSON API version is 5. Two different endpoints are available: - http://internal-tuner.pandora.com/services/json/ - https://internal-tuner.pandora.com/services/json/ + +.. index:: + single: bodyenc + single: Blowfish encryption + .. _bodyenc: Unless noted otherwise JSON-encoded requests sent by the client within the HTTP @@ -33,6 +42,10 @@ Make sure you URL encode the parameter’s values. The following values must be present in every JSON request object (if available): + +.. index:: + single: synctime + .. _synctime: ============= ====== =========== diff --git a/json/methods.rst b/json/methods.rst index d02daa1..fbc5671 100644 --- a/json/methods.rst +++ b/json/methods.rst @@ -1,3 +1,6 @@ +.. index:: + single: Methods + .. _methods: List of methods diff --git a/json/partners.rst b/json/partners.rst index a759d41..ce9eff9 100644 --- a/json/partners.rst +++ b/json/partners.rst @@ -1,3 +1,7 @@ +.. index:: + single: Partner passwords + + .. _partners: Partner passwords diff --git a/json/play.rst b/json/play.rst index 7c51680..56508e0 100644 --- a/json/play.rst +++ b/json/play.rst @@ -3,6 +3,10 @@ Play ==== + +.. index:: + single: station.getPlaylist + .. _station-getPlaylist: Retrieve playlist @@ -118,6 +122,10 @@ Usually a playlist contains four tracks. } } + +.. index:: + single: station.addFeedback + .. _station-addFeedback: Rate track @@ -184,6 +192,9 @@ station. Banned songs are never played again on this particular station. } +.. index:: + single: user.sleepSong + .. _user-sleepSong: Temporarily ban track @@ -208,6 +219,10 @@ A song can be banned *from all stations* temporarily (one month). Nothing is returned in the response. + +.. index:: + single: track.explainTrack + .. _track-explainTrack: Explain track choice diff --git a/json/stations.rst b/json/stations.rst index 590eba8..54fee44 100644 --- a/json/stations.rst +++ b/json/stations.rst @@ -7,6 +7,10 @@ A *station* is a collection of one or more user-supplied *seeds*. Artists or tracks can be used as seed. Based on the seeds Pandora decides which music to play. + +.. index:: + single: user.getStationList + .. _user-getStationList: Retrieve station list @@ -85,6 +89,10 @@ QuickMix stations additionally include a list of station ids } } + +.. index:: + single: user.getStationListChecksum + .. _user-getStationListChecksum: Check station list for modifications @@ -117,6 +125,10 @@ Add new station New stations can be created by searching for an artist/song or using a track from a playlist. + +.. index:: + single: music.search + .. _music-search: Search @@ -168,6 +180,10 @@ Matching songs and artists are returned in two separate list. } } + +.. index:: + single: user.createStation + .. _station-createStation: Create @@ -187,6 +203,10 @@ should be used as seed. musicType,string,“song” or “artist” musicToken,string,See :ref:`music-search` + +.. index:: + single: station.addMusic + .. _station-addMusic: Add seed @@ -240,6 +260,10 @@ station. } } + +.. index:: + single: station.deleteMusic + .. _station-deleteMusic: Remove seed @@ -269,6 +293,10 @@ This method does not return data. 1032,Last seed cannot be removed + +.. index:: + single: station.renameStation + .. _station-renameStation: Rename station @@ -282,6 +310,10 @@ Rename station stationToken,string,"Existing station, see :ref:`user-getStationList`" stationName,string,New station name + +.. index:: + single: station.deleteStation + .. _station-deleteStation: Delete station @@ -304,6 +336,10 @@ Delete station No data is returned in response. + +.. index:: + single: station.getStation + .. _station-getStation: Retrieve extended station information @@ -439,6 +475,9 @@ Extended station information includes seeds and feedback. } +.. index:: + single: station.deleteFeedback + .. _station-deleteFeedback: Remove feedback @@ -463,6 +502,10 @@ Feedback added by :ref:`station-addFeedback` can be removed from the station. This method has does not return data. + +.. index:: + single: station.getGenreStations + .. _station-getGenreStations: Predefined stations @@ -500,6 +543,10 @@ used as musicToken to create a new station with :ref:`station-createStation`. } } + +.. index:: + single: station.getGenreStationsChecksum + .. _station-getGenreStationsChecksum: Checksum @@ -519,6 +566,10 @@ See :ref:`user-getStationListChecksum`. checksum,string, + +.. index:: + single: station.transformSharedStation + .. _station-transformSharedStation: Transform shared station @@ -534,6 +585,10 @@ list. These stations cannot be modified (i.e. rate tracks) unless transformed. stationToken,string,See :ref:`user-getStationList` + +.. index:: + single: user.setQuickMix + .. _user-setQuickMix: Modify QuickMix |