MeeMix API
From MeeMixWiki
Contents |
Overview
Music Similarity API. Find similar tracks, artists or any relevant musical item content( such as video, event, rintones etc) based on track or artist input.
Personalized Music Recommendations API. Get recommendations for tracks, artists or any relevant musical item content based on a user profile.
Personalized Music Playlist API. Create smart playlists/radio stations based on track/artist and a user profile.
Media Libraries. For companies with large media libraries, MeeMix offer you to sync it with our media library, allowing you to utilize it for the better. Use MeeMix APIs only on your offered media files and search only the relevant content you need, if that tracks, artists, tickets, ringtones, videos or any other content you wish to attach to your tracks/artists data.
User Media Libraries (Beta!). Offer a smart playlists on a user small - medium ( Up to 5000 tracks ) media libraries.
Environments
1. Test and Integration Environment (Sandbox) , endpoint: http://ws.shadow.meemix.com/mxws/services/mxws
2. Production Environment, endpoint: http://ws.meemix.com/mxws/services/mxws
Access
MeeMix API requires partnerId and partnerKey.
To try out MeeMix API via our sandbox, please generate your own developer key by completing the request form.
Please notice that developer permissions are given only to our sandbox environment ws.shadow.meemix.com. Please use this endpoint while developing.
Developer permissions allow you up to 500 calls to the API per day. If you require more calls, please contact us.
Definitions, Requests and Responses
MeeMix API is a SOAP/REST webservice.
Definition (wsdl) file:
More data types are defined in the following files:
- API Data Types (playlist, track, artist etc.)
- Geo Data Types (country, city etc.)
- http://ws.shadow.meemix.com/mxws/services/mxws?xsd=geo_types.xsd
Its possible to get JSON responses by adding response=application/json to your requests.
Music Similarity API
Suggest recommendations or a one-time playlist to an unknown user. User information and history are not saved in the MeeMix database. Tracks/Artists are suggested based on musical DNA similarity only.
- similar.getArtistsByArtist - Searches for standalone artist recommendations according to a given artist name or MeeMix artist ID. Recommendations are based on musical DNA similarity.
- similar.getTracksByArtist - Searches for standalone track recommendations according to a given artist name or MeeMix artist ID. Recommendations are based on musical DNA similarity.
- similar.getTracksByTrack - Searches for standalone track recommendations according to a given track name or MeeMix track ID. Recommendations are based on musical DNA similarity.
Personalized Music Recommendations API
Suggest personalized recommendations to a known and recognized user. Track and artist personalized recommendations are suggested based on musical DNA similarity and user information/history. User information and playlists are saved in MeeMix, thus allowing for continued and more precise recommendations over time.
The first step to supply musical recommendations is to build the user profile; use the following functions:
- user.register - Registers a user from a partner in the MeeMix database using your assigned partner ID and a unique (in your partner namespace) user ID.
- user.setTrackAction - Notifies MeeMix about an action a specific user took regrading a specific track (purchased track, downloaded its ringtone etc.)
- user.setArtistAction - Notifies MeeMix about an action a specific user took regrading a specific artist (e.g, searched for artist event).
With the user profile we can continue to recommendations:
- user.getTracks - Retrieves personalized track recommendations for a specific user.
- user.getArtists - Retrieves personalized artist recommendations for a specific user.
- user.getEvents - An extension to the user.getArtists function. Retrieves personalized events recommendations for a specific user, with geo support.
To get the user favorite artists/tracks:
- user.getFavoriteTracks - Retrieves a specific user's favorite tracks.
- user.getFavoriteArtists - Retrieves a specific user's favorite artists.
Personalized Music Playlist API
Suggest personalized playlists to a known and recognized user. Track and artist personalized playlists are suggested based on musical DNA similarity and user information/history. User information and playlists are saved in MeeMix, thus allowing for continued and more precise playlists over time.
Use the following functions to create new playlist for the user:
- user.register - Registers a user from a partner in the MeeMix database using your assigned partner ID and a unique (in your partner namespace) user ID.
- user.getPlaylists - Retrieves the user`s personalized playlists.
- user.createPlaylistByArtist - Creates a personalized playlist based on artist name or by MeeMix artist ID.
- user.createPlaylistByTrack - Creates a personalized playlist based on track name or by MeeMix track ID.
- user.deletePlaylist - Deletes a user personalized playlist (previously created with the user.createPlaylistBy* operations).
The following actions are available on a playlist:
- playlist.getTrack - Requests the next track on a user`s personalized playlist.
- playlist.rateTrack - Rates a track previously provided by the playlist.getTrack operation on this playlist.
- playlist.getTrackRate - Return a track rate previously rated with the playlist.rateTrack operation on this playlist.
- playlist.updateName - Update the playlist name.
- playlist.setPopularity - Sets the personalized playlist's popularity level ( how many favorite songs/artists vs non familiar songs/artists to play).
- playlist.setDiscovery - Sets the personalized playlist's discovery level.
- playlist.setPulse - Sets the personalized playlist's pulse level.
- playlist.setAtmo - Sets the personalized playlist's atmosphere.
- playlist.setSurprise - Sets the personalized playlist's surprise (exploration) level.
- playlist.blockTrack - Blocks a specific track on this personalized playlist from playing for a period of time.
- playlist.blockArtist - Blocks a specific artist on this personalized playlist from playing for a period of time.
- playlist.unblockTrack - Unblocks a previously blocked track.
- playlist.unblockArtist - Unblocks a previously blocked artist.
- playlist.addTrack - Adds a track to the personalized playlist.
- playlist.addArtist - Adds an artist to the personalized playlist.
Media Libraries
Using your own Media Library: Companies with large musical databases can create and synchronize their own media libraries with the MeeMix database, and subsequently suggest musical recommendations and playlists to their users, whether unregistered or registered users based on their on tracks/artists identifiers. MeeMix will create new index for each media library.
The following functions will help you create your media library with MeeMix:
- lib.create - Creates a new media library in MeeMix (a partner can create several libraries).
- lib.addLinkType - Create a new link type (e.g. video, ringtone, etc.) A link type is every information we can attach to a track or an artist. MeeMix create an index for each link type. Thus we can get similarities only for artists that have available concert for example.
To sync your library use the following functions:
- lib.submitTrack - Submits a track to a media library.
- lib.deleteTrack - Delete a track from a media library.
- lib.trackStatus - Check submitted track status.
- lib.submitArtistLinks - Attaches links to a previously-submitted artist using the lib.submitTrack.
Help function for autocomplete feature:
- lib.artists - Return artist names and ids list based on a wildcard phrase.
User Media Libraries ( Beta! )
MeeMix offers smart playlists for small-meduim user media libraries ( until 5000 tracks ).
- user.register - Registers a user in the MeeMix database using your assigned partner ID and a unique (in your partner namespace) user ID.
- user.libSubmitTrack - Submit the user tracks to the library for syncing and analysis.
- user.libGet - Get a dump of the user media library.
- user.libGetPlaylist - Get playlists based on the submitted library and local seed track.
