From 112be71223bee7bb0ec859ac23c518b83de9f822 Mon Sep 17 00:00:00 2001 From: Mike Crute Date: Sun, 29 Oct 2017 15:48:04 +0000 Subject: Fix typos, move implementation --- implementations.rst | 41 +++++++++++++++++++++++++++++++++++++++++ index.rst | 1 + json/implementations.rst | 41 ----------------------------------------- json/index.rst | 1 - rest/authentication.rst | 2 +- rest/implementations.rst | 11 ----------- rest/index.rst | 9 +++++---- 7 files changed, 48 insertions(+), 58 deletions(-) create mode 100644 implementations.rst delete mode 100644 json/implementations.rst delete mode 100644 rest/implementations.rst diff --git a/implementations.rst b/implementations.rst new file mode 100644 index 0000000..49c0051 --- /dev/null +++ b/implementations.rst @@ -0,0 +1,41 @@ +.. index:: + single: Implementations + + +=============== +Implementations +=============== + +A list of open source Pandora JSON API implementations. + +.. csv-table:: + :header: Name,Used in client,Language,API Version,Remarks + + libpiano_, "pianobar_, pianod_", C,JSON v5,"" + Pandora_, Hermes_, Objective-C,JSON v5,"" + pydora_ (`PyPI`__), "`pydora player`_, pancake_, `mopidy-pandora`_", "Python", JSON v5,"Python 2.7+ and 3.3+ compatible" + `pithos.pandora`_, Pithos_, Python,JSON v5,"" + PandoraSharp_, Elpis_, C#,JSON v5, Not to be confused with the `original PandoraSharp`_ (uses XMLRPC) + libpanda_, Mousiki_, Vala,JSON v5,"" + gopiano_, , Go,JSON v5, "" + `WebService::Pandora`_, , Perl,JSON v5, "Perl 5.6+ compatible" + +.. _libpiano: https://github.com/PromyLOPh/pianobar/tree/master/src/libpiano +.. _pianobar: http://6xq.net/projects/pianobar/ +.. _PandoraSharp: https://code.google.com/p/elpis-pandora-client/source/browse/#svn%2Ftrunk%2FLibs%2FPandoraSharp +.. _Elpis: http://www.adamhaile.net/projects/elpis/ +.. _Pandora: https://github.com/HermesApp/Hermes/tree/master/Sources/Pandora +.. _Hermes: http://hermesapp.org/ +.. _pithos.pandora: https://github.com/pithos/pithos/tree/master/pithos/pandora +.. _Pithos: https://pithos.github.io/ +.. _`original PandoraSharp`: http://www.justin-credible.net/Projects/PandoraSharp +.. _pianod: http://deviousfish.com/pianod/ +.. _libpanda: https://github.com/techwiz24/libpanda +.. _Mousiki: http://techwiz24.github.io/mousiki/ +.. _gopiano: https://github.com/cellofellow/gopiano +.. _pydora: https://github.com/mcrute/pydora +.. _`pydora player`: https://github.com/mcrute/pydora/tree/master/pydora +.. _pancake: https://github.com/osum4est/pancake +.. _`mopidy-pandora`: https://github.com/rectalogic/mopidy-pandora +.. _`WebService::Pandora`: https://github.com/defc0n/WebService-Pandora +__ http://pypi.python.org/pypi/pydora diff --git a/index.rst b/index.rst index bd2c377..b50ca06 100644 --- a/index.rst +++ b/index.rst @@ -24,5 +24,6 @@ Suggestions and patches are welcome. .. toctree:: :maxdepth: 2 + implementations json/index rest/index diff --git a/json/implementations.rst b/json/implementations.rst deleted file mode 100644 index 72d3794..0000000 --- a/json/implementations.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. index:: - single: Implementations - - -=============== -Implementations -=============== - -A list of open source Pandora JSON API implementations. - -.. csv-table:: - :header: Name, Used in client, Language, Remarks - - libpiano_, "pianobar_, pianod_", C,"" - Pandora_, Hermes_, Objective-C,"" - pydora_ (`PyPI`__), "`pydora player`_, pancake_, `mopidy-pandora`_", "Python", "Python 2.7+ and 3.3+ compatible" - `pithos.pandora`_, Pithos_, Python,"" - PandoraSharp_, Elpis_, C#, Not to be confused with the `original PandoraSharp`_ (uses XMLRPC) - libpanda_, Mousiki_, Vala,"" - gopiano_, , Go, "" - `WebService::Pandora`_, , Perl, "Perl 5.6+ compatible" - -.. _libpiano: https://github.com/PromyLOPh/pianobar/tree/master/src/libpiano -.. _pianobar: http://6xq.net/projects/pianobar/ -.. _PandoraSharp: https://code.google.com/p/elpis-pandora-client/source/browse/#svn%2Ftrunk%2FLibs%2FPandoraSharp -.. _Elpis: http://www.adamhaile.net/projects/elpis/ -.. _Pandora: https://github.com/HermesApp/Hermes/tree/master/Sources/Pandora -.. _Hermes: http://hermesapp.org/ -.. _pithos.pandora: https://github.com/pithos/pithos/tree/master/pithos/pandora -.. _Pithos: https://pithos.github.io/ -.. _`original PandoraSharp`: http://www.justin-credible.net/Projects/PandoraSharp -.. _pianod: http://deviousfish.com/pianod/ -.. _libpanda: https://github.com/techwiz24/libpanda -.. _Mousiki: http://techwiz24.github.io/mousiki/ -.. _gopiano: https://github.com/cellofellow/gopiano -.. _pydora: https://github.com/mcrute/pydora -.. _`pydora player`: https://github.com/mcrute/pydora/tree/master/pydora -.. _pancake: https://github.com/osum4est/pancake -.. _`mopidy-pandora`: https://github.com/rectalogic/mopidy-pandora -.. _`WebService::Pandora`: https://github.com/defc0n/WebService-Pandora -__ http://pypi.python.org/pypi/pydora diff --git a/json/index.rst b/json/index.rst index f139488..1a7f576 100644 --- a/json/index.rst +++ b/json/index.rst @@ -85,7 +85,6 @@ message whereas successful requests carry actual response data in the key ads methods errorcodes - implementations .. toctree:: :hidden: diff --git a/rest/authentication.rst b/rest/authentication.rst index 763ddcc..191da4e 100644 --- a/rest/authentication.rst +++ b/rest/authentication.rst @@ -9,7 +9,7 @@ Authentication User Login ========== -:Endpoint: /v1/login +:Endpoint: /v1/auth/login Request ------- diff --git a/rest/implementations.rst b/rest/implementations.rst deleted file mode 100644 index 06cbcf7..0000000 --- a/rest/implementations.rst +++ /dev/null @@ -1,11 +0,0 @@ -=============== -Implementations -=============== - -.. index:: - single: Implementations - -A list of open source Pandora REST API implementations. - -.. csv-table:: - :header: Name, Used in client, Language, Remarks diff --git a/rest/index.rst b/rest/index.rst index a0cd991..f43d797 100644 --- a/rest/index.rst +++ b/rest/index.rst @@ -12,7 +12,6 @@ REST API ads endpoints errorcodes - implementations The Pandora REST API is used by modern Pandora apps including the website and the various mobile apps provided by Pandora. The current REST API has multiple @@ -23,9 +22,9 @@ feature set evolves. The main endpoint is: - https://www.pandora.com/api/ All requests are JSON-encoded and sent via HTTP POST body to the endpoints over -HTTPS. Response bodies are JSON-encoded values. Unlike the JSON v5 API there is -no requirement for time syncronization, Blowfish cryptography, or partner -logins. +HTTPS. Requests require a ``Content-Type`` header of ``application/json``. +Response bodies are JSON-encoded values. Unlike the JSON v5 API there is no +requirement for time syncronization, Blowfish cryptography, or partner logins. The API requires a cookie aware client as several cookies will be issued during authentication that **must** be present in every request. Failure to provide @@ -48,6 +47,7 @@ cookie in each request. POST /api/v1/auth/login HTTP/1.1 Host: www.pandora.com + Content-Type: application/json;charset=utf-8 X-CsrfToken: 123456a7889b1c23 X-AuthToken: @@ -65,6 +65,7 @@ the auth token obtained during login. It is acceptable to include the POST /api/v1/station/getStations HTTP/1.1 Host: www.pandora.com + Content-Type: application/json;charset=utf-8 X-CsrfToken: 123456a7889b1c23 X-AuthToken: dGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUgY29kZQo= -- cgit v1.2.3