Getting Started

• Overview
• Methods of Locker Loading

Scenarios

• Locker Load of a single file
• Locker Load using a zip file
• Locker Load using password
  protected zip file
• Locker Load using m3u playlist
  • Minimum playlist
  • Advanced playlist features

Implementation Details

• Obtain Partner Token
• Locker load using HTML/JavaScript
  • Include the JavaScript in your page.
  • Add the locker load links.
• Locker load using MP3tunes API
  • Obtain a session ID
  • lockerLoad API call Parameters
  • lockerLoad sample request
  • lockerLoad sample response

LOCKERLOAD SAMPLE RESPONSE

Assuming the user account already exists.

<mp3tunes>
    <status>1</status>    
    <errorMessage />    
    <userCreated>0</userCreated>    
    <userVerified>0</userVerified>    
    <loadTimeEstimate>2</loadTimeEstimate>    
    <verifyURL>https://shop.mp3tunes.com/v?user@example.com,833ebb8b11b3bc5865550d71ce132250</verifyURL>    
    <jobKey>6474a04624c73b0c8d2a92d1f7122ab9</jobKey>  
</mp3tunes>

If the account was not created as a result of the call, but the userVerified response value is 0, the verifyURL will be still be included in the response. The caller of the locker load API can then prompt the user to verify the account using this URL. The verifyURL response value will always be included if the account was created as a result of the locker load call.

The jobKey is the internal MP3tunes identifier for the locker load job. In the future, more functionality may be introduced that would use this identifier.

As with the HTML/JavaScript method, the user will receive an email notification when the tracks are available in their locker. There should be very little delay – perhaps only a few minutes. The API lockerLoad call can be used with m3u playlists as well as single files in place of the zip file. Keep in mind, a playlist cannot be automatically created if single files are loaded in separate locker load calls. The use of zip or m3u URLs is recommended for the best user experience.