diff options
| author | Mike Crute <mike@crute.us> | 2017-10-29 04:32:32 +0000 |
|---|---|---|
| committer | Mike Crute <mike@crute.us> | 2017-10-29 04:34:16 +0000 |
| commit | cbbcd70463862c5aac1c2467d70895a77bdb96b3 (patch) | |
| tree | 4b21d4eb6460c90a8fe115c5cb3f8fb8c7bd5e58 /rest/authentication.rst | |
| parent | 19f91a60a96d09584e666d5e2a9b8794e459215d (diff) | |
| download | pandora-apidoc-cbbcd70463862c5aac1c2467d70895a77bdb96b3.tar.gz pandora-apidoc-cbbcd70463862c5aac1c2467d70895a77bdb96b3.tar.bz2 pandora-apidoc-cbbcd70463862c5aac1c2467d70895a77bdb96b3.zip | |
Stub out REST API docs
Diffstat (limited to 'rest/authentication.rst')
| -rw-r--r-- | rest/authentication.rst | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/rest/authentication.rst b/rest/authentication.rst new file mode 100644 index 0000000..763ddcc --- /dev/null +++ b/rest/authentication.rst @@ -0,0 +1,88 @@ +.. _rest-authentication: + +============== +Authentication +============== + +.. _rest-v1-auth-login: + +User Login +========== + +:Endpoint: /v1/login + +Request +------- +.. code:: json + + { + "existingAuthToken": null, + "keepLoggedIn": true, + "password": "secretpassword", + "username": "email@example.com" + } + +.. csv-table:: + :header: Name,Type,Description + + username,string,User's username + password,string,User's password + +Response +-------- +.. code:: json + + { + "activeVxRewards": [], + "adkv": {}, + "allowProfileComments": false, + "artistAudioMessagesEnabled": false, + "artistPromoEmailsEnabled": false, + "authToken": "dGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUgY29kZQo=", + "birthYear": 1920, + "config": { + "branding": "PandoraPlus", + "dailySkipLimit": 60, + "experiments": [ + 123, + 456 + ], + "flags": [ + "noAds", + "adFreeSkip", + "adFreeReplay", + "noSmartConversion", + "disableNonAdPageTimeout", + "highQualityStreamingAvailable", + "replaysEnabled" + ], + "inactivityTimeout": 28800, + "monthlyListeningCapHours": 320, + "stationSkipLimit": 6 + }, + "emailOptOut": true, + "explicitContentFilterEnabled": false, + "gender": "FEMALE", + "highQualityStreamingEnabled": true, + "isNew": false, + "listenerId": "12345", + "listenerToken": "GFuIGV4YW1wbGUgY29kZQodGhpcyBpcyBqdXN0I", + "minor": false, + "notifyOnComment": true, + "notifyOnFollow": true, + "profilePrivate": true, + "seenEducation": true, + "smartConversionAdUrl": "https://adserver.pandora.com/...", + "smartConversionDisabled": true, + "smartConversionTimeoutMillis": 5000, + "stationCount": 13, + "username": "email@example.com", + "webClientVersion": "0.48.0", + "webname": "user", + "zipCode": "12345" + } + +.. csv-table:: + :header: Name,Type,Description + + authToken,string,See :ref:`rest-auth-token` |