Created by Stephen Smith on Oct 23, 2018

The fan_club endpoint allows services to request authentication codes for fan-club applications and then verify those codes (e.g. after the new user has paid for the membership)

Generate Code

Generate a membership purchase code. Once this code is verified, it can be given to a user to register their fan club membership

Path: /fan_club/generate_code

Authentication: standard

Arguments: passed as named GET or POST parameters

  • membership_length - int - number of seconds the membership will be valid for. Defaults to 6, 12, or 18 months as specified by the band
  • code - string - a unique alphanumeric string identifying this code. Auto-generated by default.
  • validated - boolean - has this subscription already been verified? Defaults to FALSE

Result: 

  • code - string - a full verification code consisting of 'CODE-CID' where CODE is an alphanumeric string (per code in the arguments) and CID is a numeric ID

Verify Code

Flag a membership purchase code as verified.

Path: /fan_club/verify_code

Authentication: standard

Arguments: passed as named GET or POST parameters

  • code - string - of the format "CODE-CID" per the result of  /fan_club/generate_code (required)

Result:

  • status - boolean - was this code able to be verified?
  • error - string - a description of what went wrong if status==FALSE
  • message - string - a description stating the verification was sucessful
  • url - string - a url to redirect users to to complete their registration

Merch Details

Return details of the default membership merch item from the band site's store.

Path: /fan_club/merch_details

Authentication: standard

Arguments: None

Result:

  • url - string - URL linking to the default membership merch item on the band site
  • image - string - Image URL for a picture representing the membership merch item
  • price - string - Cost of the membership merch item. Decimal places are allowed
  • currency - string - ISO abbreviation on the currency the merch is purchased with (e.g. "USD")
  • membership_length - int - Number of seconds a fan club membership is extended by when this item is purchased