User Endpoint
The User Endpoint handles all User-related Functionalities within a valid Frontend Session. It does not handle User Interaction, you can find those Endpoints here:
Account Management
/register
POST
https://api.nexx.cloud/v3.1/user/register
This Endpoint registers a User. All User entered Details must be valid POST Attributes (like username, firstname etc).
Request Body
/registeranonymous
POST
https://api.nexx.cloud/v3.1/user/registeranonymous
This Endpoint registers an anonymous User. All User-related Details may be sent via POST (all Attributes are valid except Username).
Request Body
/verifyaccountdetailsunique
POST
https://api.nexx.cloud/v3.1/user/verifyaccountdetailsunique/:item
This Endpoint validates a Username and/or Email Address for Uniqueness.
Path Parameters
/verifytokenunique
POST
https://api.nexx.cloud/v3.1/user/verifytokenunique/:token
This Endpoint validates a 3rd Party Connector Token for Uniqueness.
Path Parameters
Request Body
/authorize
POST
https://api.nexx.cloud/v3.1/user/authorize/:token
This Endpoint represents the final Step in a Registration Process (if AutoAuthorize is disabled).
Request Body
/authorizedevice
POST
https://api.nexx.cloud/v3.1/user/authorizedevice
will verify a new Device for a User with 2FA Login.
Request Body
/authorizelogin
POST
https://api.nexx.cloud/v3.1/user/authorizelogin
will verify a Login for a User with U2F Device
Request Body
/prepareavsupdate
POST
https://api.nexx.cloud/v3.1/user/prepareavsupdate
Request Body
/finishavsupdate
POST
https://api.nexx.cloud/v3.1/user/finishavsupdate
Request Body
/registerdeviceforpush
POST
https://api.nexx.cloud/v3.1/user/registerdeviceforpush
marks the Device as willing to receive Push Messages
Request Body
/prepareregisteru2fdevice
POST
https://api.nexx.cloud/v3.1/user/prepareregisteru2fdevice
will create the Challenge for a new U2F Request
Request Body
/finishregisteru2fdevice
POST
https://api.nexx.cloud/v3.1/user/finishregisteru2fdevice
Request Body
/prepareregisterauthenticator
POST
https://api.nexx.cloud/v3.1/user/prepareregisterauthenticator
will create the Challenge for a new U2F Request
/finishregisterauthenticator
POST
https://api.nexx.cloud/v3.1/user/finishregisterauthenticator
Request Body
/requesttakeout
POST
https://api.nexx.cloud/v3.1/user/requesttakeout
/resetpassword
POST
https://api.nexx.cloud/v3.1/user/resetpassword/:token
will reset the User Password to a self-given new Value. This is only valid for a predefined Password Reset Link, which Token must be given too.
Path Parameters
Request Body
/resendwelcomemail
POST
https://api.nexx.cloud/v3.1/user/resendwelcomemail
will resent the User Welcome Email (needs the Eternal Session and a Backend Process).
/verifypassword
POST
https://api.nexx.cloud/v3.1/user/verifywelcome
will verify, that the given Password matches the stored User Password
Path Parameters
/profile
GET
https://api.nexx.cloud/v3.1/user/profile
Query Parameters
/requestpass
GET
https://api.nexx.cloud/v3.1/user/requestpass
will try to find a registered and authorized User and sends an Email with new Login Details to that Account.
Query Parameters
/requestkeycode
GET
https://api.nexx.cloud/v3.1/user/requestkeycode
will invalidate all open 2FA Codes and generates a new Code for the given Device.
/changepassword
PUT
https://api.nexx.cloud/v3.1/user/changepassword
Request Body
/updatestatus
PUT
https://api.nexx.cloud/v3.1/user/updatestatus
Request Body
/updatechannelsubscriptions
PUT
https://api.nexx.cloud/v3.1/user/updatechannelsubscriptions
updates a User Notification Preferences for new Media in a given Channel.
Query Parameters
/updatedata
PUT
https://api.nexx.cloud/v3.1/user/updatedata
will update all User Details (except Password, Username and Status). All given User Details must be sent via PUT Parameters as in the /register Endpoint.
Request Body
/unsubscribe
DELETE
https://api.nexx.cloud/v3.1/user/unsubscribe
unsubscribe from all Newsletters
/unregister
DELETE
https://api.nexx.cloud/v3.1/user/unregister
will remove the User completey. This Operation cannot be undone, so use with extreme Care.
Media Item Lists
Media Item List Endpoints return Lists of Media Items, that the User interacted in any Way.
/history
GET
https://api.nexx.cloud/v3.1/user/history
Query Parameters
/historyformerge
GET
https://api.nexx.cloud/v3.1/user/historyformerge
This special Endpoint is designed for History Synchronization on Login. It only returnes the Media IDs and will always return ALL of them - Paging is not supported in this Case.
Query Parameters
/searchhistory
GET
https://api.nexx.cloud/v3.1/user/searchhistory
Query Parameters
/purchaseditems
GET
https://api.nexx.cloud/v3.1/user/purchaseditems
Query Parameters
/favourites
GET
https://api.nexx.cloud/v3.1/user/favourites
Query Parameters
/watchlist
GET
https://api.nexx.cloud/v3.1/user/watchlist
Query Parameters
/cart
GET
https://api.nexx.cloud/v3.1/user/cart
/itemsininterest
GET
https://api.nexx.cloud/v3.1/user/itemsininterest
/likes
GET
https://api.nexx.cloud/v3.1/user/likes
Query Parameters
/ratings
GET
https://api.nexx.cloud/v3.1/user/ratings
Query Parameters
/comments
GET
https://api.nexx.cloud/v3.1/user/comments
Query Parameters
/clips
GET
https://api.nexx.cloud/v3.1/user/clips
/uploads
GET
https://api.nexx.cloud/v3.1/user/uploads
Request Body
/teams
GET
https://api.nexx.cloud/v3.1/user/teams
/events
GET
https://api.nexx.cloud/v3.1/user/events
User Media
/prepareupload
POST
https://api.nexx.cloud/v3.1/user/prepareupload
This Endpoint will return Upload URLs, Tokens and Filenames for all file based UGC Uploads.
Request Body
/finishupload
POST
https://api.nexx.cloud/v3.1/user/finishupload
This Endpoint will return Upload URLs, Tokens and Filenames for all file based UGC Uploads.
Request Body
/addarticle
POST
https://api.nexx.cloud/v3.1/user/addarticle
This Endpoint will create a UGC Media Item of Streamtype "article".
Request Body
/addplaylist
POST
https://api.nexx.cloud/v3.1/user/addplaylist
Thsi Endpoint will create a UGC Media Item of Streamtype "playlist".
Request Body
/addcollection
POST
https://api.nexx.cloud/v3.1/user/addcollection
This Endpoint will create a UGC Media Item of Streamtype "collection"
Request Body
Last updated