AuthenticateRemoteUser¶
Automatically log in a remote user by appending a token provided by this API method call.
Request¶
GET https://api.uberflip.com/?Version=0.1&Method=AuthenticateRemoteUser&APIKey=xxxxxxx&Signature=xxxxxx&TitleId=12345&RemoteUserId=203&ResponseType=XML
URL Parameters | Description |
---|---|
Version | The version of the API to call (0.1 ). |
Method | The method being called (AuthenticateRemoteUser ). |
APIKey | Your account’s API key. |
Signature | Your account’s API signature. |
UserId | (required for master/reseller accounts) The account identifier of the account to call the method on. |
TitleId | The identifier of the Title to log the remote user into. |
RemoteUserID | (optional) The identifier of the remote user to log in. |
ResponseType | (optional) The response format (XML or JSON ). Defaults to JSON . |
Example Usage¶
Using the supplied token, you can bypass the login screen for your Remote Authentication enabled Title and give valid users instant access to your publication. Simply append ?token=Yjk5YmU4Nzc3OGM4ZDljZTIyN
to the end of either the Title or Issue link.
http://hub.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 log in whereby the user has already been authenticated on your website by your own login system.