Docs > API > AuthenticateSubscriber

API Documentation

API MENU

Authentication Methods » AuthenticateSubscriber

Automatically log in a subscriber by appending a token provided by this API method call.

Required paramaters: standard, TitleId, SubscriberId

Optional paramaters: standard

For master account Key/Signature pair, the paramater UserId is also required.

Example Response (XML)

<Token>Yjk5YmU4Nzc3OGM4ZDljZTIyN</Token>

Example Usage

Using the supplied token, you can bypass the login screen for your Subscription Module enabled Title and give valid subscribers instant access to your publication. Simply append ?token=Yjk5YmU4Nzc3OGM4ZDljZTIyN to the end of either the Title or Issue link.

i.e. www.publishingdomain.com/issue/12345?token=Yjk5YmU4Nzc3OGM4ZDljZTIyN

Once the token is accessed, it is removed and cannot be used again. This is to ensure that if the token-appended link is shared it cannot be abused.

This is most commonly used to avoid double login whereby the subscriber has already been authenticated on your website by your own login system.