Interactive login is to be used when the user is present to login (for example, 3rd Party Desktop Applications) and will manage any additional information required at login depending upon a customer's account (such as 2 Factor Authentication codes or National Identifiers).
This is achieved by embedding the Betfair IdentitySSO login page in your application and then obtaining a successful session token upon login. The keep alive operation should be called within the 20 minute session expiry time if the user is still actively using your application. The embedded login page initially looks like this:
Interactive Login White-listing
Use of the Interactive Login requires your App Key to be white-listed. To get your App Key white-listed you should raise a Support Ticket via Support > Create A Support Ticket and provide your Application Key/s and Application Name as well as details of your intended use of the interactive login,(i.e. whether this is for personal use or for an application that you intend to distribute to Betfair customers under the terms of the Software Vendor licence).
The interactive login sequence looks like this:
- loginStatus - A code which will either be 'SUCCESS' or an error code from the table below.
- productToken - This is your session token and should be attached to requests made to API-NG in the X-Authentication header.
|ACCOUNT_ALREADY_LOCKED||the account is already locked|
|ACCOUNT_NOW_LOCKED||the account was just locked|
|AGENT_CLIENT_MASTER||Agent Client Master|
|AGENT_CLIENT_MASTER_SUSPENDED||Suspended Agent Client Master|
|BETTING_RESTRICTED_LOCATION||the account is accessed from a location where betting is restricted|
|CERT_AUTH_REQUIRED||Certificate required or certificate present but could not authenticate with it|
|CHANGE_PASSWORD_REQUIRED||change password required|
|CLOSED||the account is closed|
|DANISH_AUTHORIZATION_REQUIRED||danish authorization required|
|DENMARK_MIGRATION_REQUIRED||denmark migration required|
|INVALID_CONNECTIVITY_TO_REGULATOR_DK||the DK regulator cannot be accessed due to some internal problems in the system behind or in at regulator; timeout cases included.|
|INVALID_CONNECTIVITY_TO_REGULATOR_IT||the IT regulator cannot be accessed due to some internal problems in the system behind or in at regulator; timeout cases included.|
|INVALID_USERNAME_OR_PASSWORD||the username or password are invalid|
|ITALIAN_CONTRACT_ACCEPTANCE_REQUIRED||The latest italian contract version must be accepted|
|NOT_AUTHORIZED_BY_REGULATOR_DK||the user identified by the given credentials is not authorized in the DK's jurisdictions due to the regulators' policies. Ex: the user for which this session should be created is not allowed to act(play, bet) in the DK's jurisdiction.|
|NOT_AUTHORIZED_BY_REGULATOR_IT||the user identified by the given credentials is not authorized in the IT's jurisdictions due to the regulators' policies. Ex: the user for which this session should be created is not allowed to act(play, bet) in the IT's jurisdiction.|
|PERSONAL_MESSAGE_REQUIRED||personal message required for the user|
|SECURITY_QUESTION_WRONG_3X||the user has entered wrong the security question 3 times|
|SECURITY_RESTRICTED_LOCATION||the account is restricted due to security concerns|
|SELF_EXCLUDED||the account has been self excluded|
|SPAIN_MIGRATION_REQUIRED||spain migration required|
|SPANISH_TERMS_ACCEPTANCE_REQUIRED||The latest spanish terms and conditions version must be accepted|
|SUSPENDED||the account is suspended|
|TELBET_TERMS_CONDITIONS_NA||Telbet terms and conditions rejected|
|TRADING_MASTER||Trading Master Account|
|TRADING_MASTER_SUSPENDED||Suspended Trading Master Account|
Spanish jurisdiction users:
Italian jurisdiction users:
Please note that all method names are case sensitive, this includes login, keepAlive and logout.
|product(mandatory)||The product for which the login page is used and on which the user will do the login; This should be your application key.||"IhDSui3ODdsdwo"|
|url (mandatory)||The url to which the the browser should be redirected in case of a successful login. |
By default, https://www.betfair.com will be allowed but further URLs can be added upon agreement with Betfair.