Differences

This shows you the differences between two versions of the page.

Link to this comparison view

logging in [2016/09/14 14:19] (current)
Line 1: Line 1:
 +====== Logging In ======
  
 +There are potentially several methods to log in to any WorkXpress Application: ​
 +  * Manual Login via a Username and Password (**Most Common**).
 +  * Manual/​Automatic Login via Facebook
 +  * Automatic Login via the Platform Interface.
 +  * Automatic Login via a Custom URL
 +  * Login via our SOAP API.
 +
 +===== Manual Login via a Username and Password =====
 +The most common method for logging into a WorkXpress Application is via the login page.  When you visit a WorkXpress application (like, [[https://​platform.workxpress.com]]) you are presented with a Log In screen that allows you to enter your Username and Password. ​ If they match a User [[Record|record]] in the WorkXpress application you're attempting to log in to, then it will accept your credentials,​ and send you to the main page of the application.
 +
 +{{ :​login:​platformlogin.png?​nolink |}}
 +
 +If you have forgotten your username or password, you can request a reset or have your username sent to you by clicking "​Forgot your Username or Password?"​. ​ This process requires you to provide the email address of a User record in the WorkXpress application.
 +
 +You can log out of the WorkXpress Application anytime by clicking "​Logout"​ in the top right hand corner.
 +
 +===== Manual/​Automatic Login via Facebook =====
 +Another common method for logging into a WorkXpress Application is via the Facebook Login button on the login page.  Some applications have been configured to allow logging in via Facebook, but not all have.  When you click the Facebook Login button a popup will open from Facebook and allow you to enter your Facebook credentials. ​ Once accepted, you will be logged into the WorkXpress Application and redirected into the main page of the application.
 +
 +{{ ::​login:​platformlogin_withfacebook.png?​nolink |}}
 +
 +==== Setting up Login via Facebook ====
 +
 +First [[Setup Facebook Account|Setup a Facebook Application]] via the Facebook developer site.
 +
 +When a user logs in via Facebook, WorkXpress will attempt to find an existing user that matches the email address provided by Facebook. ​ If the email does not match any then a new user will be created and up to 8 pieces of data will be stored on that user.  To optionally store the data provided by Facebook use the following fields on the WorkXpress Application Table to select a storage location: ​
 +
 +  * Choose a Field on User to store their Age Range
 +  * Choose a Field on User to store their First Name
 +  * Choose a Field on User to store their Gender
 +  * Choose a Field on User to store their Last Name
 +  * Choose a Field on User to store their Link
 +  * Choose a Field on User to store their Locale
 +  * Choose a Field on User to store their Name
 +  * Choose a Field on User to store their Username
 +
 +The final step is to configure the Facebook Application to recognize the url of the WorkXpress Application. ​ First, log in to the Facebook Developers website and choose the "​Settings"​ option for the Facebook Application. ​ Then click "Add Platform"​ at the bottom and choose "​Website"​. ​ Last, enter the base url for the WorkXpress Application.
 +
 +{{ ::​facebook_login_url.png?​nolink |}}
 +
 +//Note: Each User can only be logged into one Facebook Account at a time.//
 +
 +==== Sending Posts to Facebook ====
 +
 +Posting to the timeline of a User who has logged in via Facebook is easy: just setup an [[Enterprise Service Bus - Facebook|Enterprise Services Bus action]] to post to their wall!
 +
 +===== Automatic Login via the Platform Interface =====
 +As a Software Developer, when you are using the WorkXpress Platform Application you will see screens that look like this: 
 +
 +{{ ::​login:​autologin_fromplatform.png?​nolink |}}
 +
 +By clicking on the Red Blocks, the Yellow Car, or the Green Rocket Ship it will log you in to the Development,​ Testing, or Production installation pictured, respectively. ​ This login is facilitated via public key encryption, and as such the password of the user you want to login as is not something you need to know.  You can adjust which user you login as by clicking on the header above this image (Development,​ Testing, Production),​ and changing the value in the "Auto Login Username"​ field. ​ This method of login is only possible inside the WorkXpress Platform Application.
 +
 +===== Automatic Login via a Custom URL =====
 +
 +By generating [[Custom URLs|custom URLs]] (like https://​platform.workxpress.com/​registration) for instance, you can create a URL to your application that will automatically log the person in as a particular user (like a "​registration"​ user, for instance). ​ This is useful for creating public facing content in your WorkXpress Application.
 +
 +===== Login via our SOAP API =====
 +
 +Whenever you process an API call through the [[Dev Resources - API|WorkXpress API]], the [[API Key Generator|API Key]] you provide has User information embedded in it.  The activities that the API undertakes are done on behalf of whatever user the API Key was generated for.
logging in.txt ยท Last modified: 2016/09/14 14:19 (external edit)
Copyright WorkXpress, 2019