MN Open: API Implementation Guide September 2009 Table of Contents MN Open: API Implementation Guide ........................................................................................................... 1 Customer Support with the MN Open API ................................................................................................. 2 Introduction ................................................................................................................................................ 3 Security: Customer Authentication and Encryption ............................................................................... 4 Transaction Options .................................................................................................................................. 4 Credit Card Payments ............................................................................................................................ 4 Account Balance Payments ................................................................................................................... 4 Pricing, Required Retail Price and Tax Handling .................................................................................. 5 Territory Restriction ................................................................................................................................ 6 Bitrate information .................................................................................................................................. 6 The MN Open APIs ................................................................................................................................... 7 MN Open API Package and Method Overview ................................................................................... 10 Global Parameters ............................................................................................................................... 12 Paging .................................................................................................................................................. 12 Generating Signatures with your Shared Secret ................................................................................. 12 Tips for Methods That Require a POST Body ..................................................................................... 13 Sample Streaming with Flash: RESOURCE and LOCATION ............................................................. 13 PHP, cUrl, and Content-type Header Setting ...................................................................................... 14 Download Locations and Single Download ......................................................................................... 14 Environments: Integration (IE) and Production (PROD) ...................................................................... 14 How to Search for International Language Data ................................................................................. 15 Handling Album-only Tracks ................................................................................................................ 16 Image Data .......................................................................................................................................... 16 Common Response Data Elements .................................................................................................... 17 Common Errors .................................................................................................................................... 21 Content Discovery ................................................................................................................................ 22 Search.GetTracks ............................................................................................................................ 22 Search.GetAlbums ........................................................................................................................... 23 Search.GetArtists ............................................................................................................................. 24 Search.GetGeoLocation ................................................................................................................... 24 Search.ContentMatch....................................................................................................................... 25 Track.Get .......................................................................................................................................... 26 Track.GetLocations .......................................................................................................................... 26 Album.GetTracks .............................................................................................................................. 27 Artist.GetAlbums .............................................................................................................................. 28 Artist.GetTracks ................................................................................................................................ 28 Provisioning ......................................................................................................................................... 30 User.Create ...................................................................................................................................... 30 User.Get ........................................................................................................................................... 31 User.IsUsernameAvailable ............................................................................................................... 32 User.Login - DEPRECATED ............................................................................................................ 32 User.SetPassword ............................................................................................................................ 33 User.Update ..................................................................................................................................... 34 Cart.AddItems .................................................................................................................................. 35 Cart.Clear ......................................................................................................................................... 37 Cart.Get ............................................................................................................................................ 37 Cart.GetCartByUser ......................................................................................................................... 38 Cart.GetDownloadLocations ............................................................................................................ 38 Cart.Purchase .................................................................................................................................. 39 MediaNet Digital Confidential Page 1 of 69 Cart.RemoveItems ........................................................................................................................... 41 Purchase.UseBalance ...................................................................................................................... 42 Purchase.UseCreditCard ................................................................................................................. 45 Management ........................................................................................................................................ 49 Partner.GetAMGData ....................................................................................................................... 49 Partner.GetBalance .......................................................................................................................... 50 Partner.RefillBalance ........................................................................................................................ 50 Report.GetOrderHistory ................................................................................................................... 52 Use Cases ............................................................................................................................................... 54 CART MANAGEMENT USE CASES ................................................................................................... 54 USER MANAGEMENT USE CASES .................................................................................................. 55 Appendix A: Sony Agency Model Nexuses and Tax Rates .................................................................... 57 Appendix B: Label Owners by Identifier and Name ................................................................................ 58 Appendix C: Change History / Errata ...................................................................................................... 68 Customer Support with the MN Open API To ask questions about and receive support for the MN Open API, please contact [email protected]. This is an internal distribution list monitored by subject matter experts around the company. We will get back to you within 24 hours during regular business hours (Pacific Time). With any correspondence, please include: • Issue Description including expected and actual results • Repro Steps • API call(s) and response(s) o URL with query string