- Home
- Quick Overview
- App Manager
- SDKs
- Features
- REST API
- API Intro
- App Authentication
- Application Data
- Custom Auth
- Custom Data
- Events
- Events Intro
- Event Add
- Event Get
- Event Update
- Event Comment Add
- Event Comment Delete
- Event Comments Get
- Event Comment Update
- Event Participant Invite
- Event Participants Invite
- Event Participants Get
- Event Participant Delete
- Event Request Invitation
- Event RSVP
- Events Search
- Events Search by Person ID
- Event AppData Add
- Event AppData Delete
- Event AppData Get
- Event AppData Get All
- Event AppData Update
- Friends
- GeoCode
- Locations
- Notifications
- Persons
- Definitions
- Enums
Facebook Auth
Proxomo allows you to easily simplify and enhance user registration and sign-in by allowing users to sign in to your app with their Facebook accounts. That way, as long as the user is signed into Facebook, they are automatically signed into your app as well which helps you create a more seamless social experience.
When users sign in to your app using Facebook, three things need to happen. First, Facebook needs to authenticate the user. This ensures that the user is who they say they are. Second, Facebook needs to authenticate your app. This ensures that the user is giving their information to your app and not someone else. Lastly, the user must explicitly authorize your app to access their information. This ensures that the user knows exactly what data they are disclosing to your app.
Do not worry if these steps seem complex. Start by providing a Facebook Login button in your app's sign in window. Then, when the your user clicks on it, Proxomo handles most of the work and simplifies what you have to do into the following simple steps:
- Your app uses a web browser to navigate to a specific Proxomo URL (details below).
-
Proxomo redirects the web browser through a sequence of URLs to authenticate the app and the user. Namely, this allows Facebook to,
- Make sure that the user is signed in on Facebook
- Present the user with info about your app and the user data you are requesting
- Prompt the user to allow your app to access the specified Facebook data
- When the process completes, Proxomo will notify your app by navigating to a specific URL.
-
Your app parses the URL's Query String to determine the outcome and additional information about the sign-in operation.
Let's look at each step in detail. Note that the details for each step may vary slightly depending on whether you are developing a mobile app or a web app.
Step 1 - Navigate to a specific Proxomo URL
From your app, use a browser to send your request into Proxomo by navigating to the URL listed below. Include the key/value pairs in the Query String as specified.
| From a Web App |
|---|
|
Navigate to:
https://service.proxomo.com/login.aspx?application_id= {applicationid}&display_type=page&response_url={response_url}&auth_token={auth_token}
applicationID, auth_token: Refer to the ??? section.
response_url: a URL within your app where you want Proxomo to navigate to once the authentication process completes.
|
| From a Mobile App |
|---|
|
Navigate to:
https://service.proxomo.com/login.aspx?application_id=
{applicationid}&display_type=mobile&auth_token={auth_token}
applicationID, auth_token: Refer to the ??? section.
Proxomo will notify your app when the authentication process completes by navigating to the following URL:
https://service.proxomo.com/LoginComplete.aspx?{QueryString}
Refer to Step 4 for details on the Query String contents.
|
Step 2 - Proxomo redirects your browser to perform authentication
There is nothing that you need to do for this step since Proxomo handles the details of redirecting the browser through a series of intermediate URLs, including Facebook, as it performs the authentication and authorization process.
Within Facebook, the user will be asked to log in to their Facebook account. If this is the first time the user is login into your application, Facebook will also prompt the user to grant your application access to the Facebook permissions that your application is requesting.
Step 3 - Proxomo notifies your app that process completed
Once the end-user authentication process completes, Proxomo notifies your app by navigating to the specific URL described in step 1. Notice that the URL contains Query String parameters that your app will parse to figure out the outcome of the end-user authentication (Step 4).
| From a Web App |
|---|
|
Proxomo navigates to the URL you specified on Step 1:
{response_url}?{query_string}
response_url: URL your specified on Step 1.
query_string: contains the outcome of the auth process. See Step 4 for how to interpret it.
|
| From a Mobile App |
|---|
|
Proxomo navigates to the following URL:
https://service.proxomo.com/LoginComplete.aspx?{query_string}
query_string: contains the outcome of the auth process. See Step 4 for how to interpret it.
Notice that your app needs to monitor when your browser arrives at this URL. As an example, your app can monitor every time the URL being displayed changes to determine when the process has completed.
|
Step 4 - Your App Parses the Query String to Determine the Outcome
Proxomo notifies you of the outcome of the sign-in operation by returning a query string containing the result as well as additional details. Of these details is Your app parses the Query String as follows:
The Query String will always contain a key named 'result'. This key is used to communicate the LoginResult of the authentication process. You can then access additional key-value information from the Query String based on the result of the operation:
| Result | Query String |
|---|---|
|
error
|
Proxomo navigates to the URL you specified on Step 1:
{response_url}?{query_string}
response_url: URL your specified on Step 1.
query_string: contains the outcome of the auth process. See Step 4 for how to interpret it.
|
| success |
Query String format:
result=success&personID={personID}&socialnetwork={socialnetwork}&
socialnetwork_ID={socialnetwork_ID}&access_token={access_token}
personID: Proxomo assigned unique identifier for this user ('ID' property in this user's Person record).
If this is the first time that this particular user is signing in to your app, then Proxomo will create this new Person record. If it is not the first time then a record already exists and Proxomo just returns the ID for this record. You can then use this record ID to access the record and get/add/update any user-specific information.
socialnetwork: SocialNetwork where user was authenticated in (in this case, Facebook).
socialnetwork_ID:FacebookID for the user ('Facebook' ID property under the user's Person record).
access_token: Proxomo-generated authentication token associated with this particular user using this app.
Notice that this authentication token is not used by the current released version of Proxomo. A future version will allow your app to pass this in order to interact with this user's unique data within your app. |
| cancel |
Query String format:
result=cancel |