Skip to end of metadata
  • Created by Former user, last modified by Former user on May 14, 2014
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

  • 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.

Subscribing a New Customer

Preconditions: Customer has a Betfair account.  Vendor has a Betfair vendor account, the app key for their app, and their (Vendor) session token.

  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 from the Vendor’s web site.
  3. The Vendor’s web site server then calls the Account API-NG operation getApplicationSubscriptionToken, passing in the Vendor’s app key, a valid 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 the form ABCD-EFGH-IJKL.
  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 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 requires Customer to login to Betfair using interactive login method. See sample code interactive login sample code here
  7. Betfair returns Customer’s session token to the app.
  8. The subscription is then activated by the app calling activateApplicationSubscription passing in the subscription token and a valid session token for the Customer

 

 

Checking a Customers Subscription History

In this scenario the Vendor wishes to check the customer’s subscription status to establish if the customer has:

  1. An Existing active subscription.
  2. An Expired subscription.
  3. A Cancelled subscription.
  4. No current or previous subscription history (i.e. Customer is entirely new).

Preconditions: Customer has a Betfair account.  Vendor has a Betfair vendor account, the app key for their app, and their (Vendor) session token.

  1. Vendor’s app client requires Customer to login to Betfair using interactive login method.  See sample code for interactive login here
  2. Betfair returns Customer’s 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 token, Vendor’s app 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).



  • No labels