References

Overview

Fanmiles Connect provides an easy way for people to sign up or login to your app with their Fanmiles account credentials. It also allows you to access account information such as the Fanmiles ID which would be difficult to collect through your own registration process. This convenient experience leads to higher conversion rates and allows you to immediately start rewarding people for their activities in your apps.

Fanmiles Connect is based on OpenID, the open identity layer for the web. There is a lot of client implementations available which allows developers to quickly integrate Fanmiles Connect.

User Experience

In order to have a great onboarding experience in your app it is essential that you first show the value of connecting with Fanmiles. It is important that people understand what they get after they connected with Fanmiles.

Permissions

When a person logs into your app via Fanmiles Connect you can access a subset of that person’s data like the username and the Fanmiles ID. The person has to explicitly allow access to this profile data and can cancel the process.

Access and Open ID Tokens

After connecting through Fanmiles Connect an app will receive an access token for the connecting Fanmiles user. An access token is an opaque string that identifies a Fanmiles user.To ensure the privacy of a Fanmiles user it is required for all Fanmiles API calls to the /me endpoint. Access tokens must be obtained via Fanmiles Connect. The token includes information about when the token will expire and which app generated the token.

Authentication Request with Implicit Flow

Pre-condition

  • Request access to the Fanmiles developer program: https://partners.fanmiles.com/developers-signup
  • Register your app with the app name, app logo and at least one redirect URI, to obtain a valid client_id and client_secret (Note: The client_secret is not required for Fanmiles Connect but it is necessary for uploading transaction files to the Fanmiles SFTP server)

Flow description

  • Client prepares an Authentication Request containing the desired request parameters.
  • Client sends the request to the Fanmiles Authorization Server.
  • Fanmiles Authorization Server authenticates the End-User.
  • Fanmiles Authorization Server obtains End-User Consent/Authorization.
  • Fanmiles Authorization Server sends the End-User back to the Client with an IDToken and, if requested, an Access Token.
  • Client validates the tokens and retrieves the Fanmiles ID and username.

Find all the details here: https://openid.net/specs/openid-connect-implicit-1_0.html

Example of Authentication Request

Example of /me call

Request Parameters

All the other Request Parameters part of the OpenId Connect standard are optional and should not be used for now.

Developer Support

Contact Fanmiles Developer Support for further questions. We are happy to receive your inputs and discuss implementation ideas. Please contact us via developers@fanmiles.com.

Did this answer your question?