Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Grant permission for users to access your application
  • Set the permission to expire after a specific date
  • Store arbitrary information against each subscription
  • View existing and historical application subscriptions

Info
  • The introduction of Subscription Tokens, to provide a single identifier for a customer's subscription to an application.
  • The use of Application Keys, which replace product and vendor software IDs, to control API access.
  • For details of the operations to manage subscriptions, please see the Accounts section of the API-NG Reference Guide.

...

Anchor
Subscribing
Subscribing
Subscribing a Customer

 

Preconditions:

  • Customer has a Betfair account. 
  • Vendor has a Betfair vendor account, the

...

  • App Key for their app, and their (Vendor) session token

...

Example flow:

  1. Customer visits Vendor’s web site and decides to sign up for the Vendor’s app.
  2. The Customer purchases a 12 month subscription to the application app from the Vendor’s web site.
  3. The Vendor’s web site website server then calls the Account API-NG operation getApplicationSubscriptionToken, passing in the Vendor’s app keyApp Key, a valid session token Session Token for the Vendor’s Betfair account (to prove that they own that App Key) and the length of the subscription required (365 days in this scenario).
  4. Betfair returns to the vendor a Subscription Token of in the form of ABCD-EFGH-IJKL .to the Vendor
  5. The Subscription Token is then provided to the instance of the Vendor’s app used by the Customer. 

    This may happen in a number of ways, including:

    i)  Emailed from Vendor to Customer, who then types the subscription token Subscription Token into the app.
    ii) Associated with the Customer’s app instance by the Vendor, so that the token can be cited by the app based on Customer login to the app.

  6. The Vendors App app requires the Customer to login to Betfair using interactive login the Interactive Login method. See sample code interactive login Interactive Login sample code here
  7. Betfair returns Customer’s session token Session Token to the app.
  8. The subscription is then activated by the app calling activateApplicationSubscription passing in the subscription token Subscription Token and a valid session token Session Token for the Customer

 

 

Anchor
CheckingSub
CheckingSub
Checking a Customers Subscription History

...

  1. Vendor’s app client requires Customer to login to Betfair using interactive login the Interactive Login method.  
  2. Betfair returns Customer’s session token Session Token to the Vendor’s app client.
  3. Vendor’s app client calls getApplicationSubscriptionHistory citing Vendors App Key in the request body and the customer's session token Session Token in the X-Authentication header.
  4. Betfair returns Customer’s subscription history.  If an empty list is returned then the customer has no current or previous subscription history (i.e. Customer is entirely new)

...

  1. Vendor’s app client requires Customer to login to Betfair using interactive login Interactive Login method.  
  2. Betfair returns Customer’s session token Session Token to the Vendor’s app client.
  3. Vendor’s app client calls getVendorClientId citing Customer’s session token from step 1.
  4. Betfair returns Customer’s vendorClientId.
  5. Vendor’s App client sends Customer’s vendorClientId to Vendor’s app server.
  6. Vendor’s app server calls getApplicationSubscriptionHistory citing Vendor’s session tokenSession Token, Vendor’s app keyApp Key, and the vendorClientID from step 4.
  7. Betfair returns Customer’s complete history for the Vendor’s app (as identified by the app key cited in step 5).  If an empty list is returned then the customer has no current or previous subscription history (i.e. Customer is entirely new).

...