Kompoz Developer Center

REST Services

REST stands for Representational State Transfer. Most of the Komopoz Web Services use "REST-Like" RPC-style operations over HTTP GET or POST requests with parameters URL encoded into the request. Kompoz Web Services are for developers, businesses and researchers interested in using the Kompoz platform to create new and useful application for Kompoz members.

REST services offer several advantages, such as:

• They are easy to build.
• URLs are easy to construct and can be tested using your browser.
• Results are human-readable

REST URL Construction

Most API requests will use GET, but data can also be submitted using a POST. All service URLs start with the host name, such as:

     http://www.kompoz.com/

After the host name, include the context and the service version number, such as:

   /compose-collaborate/v-1.0/

Next is the service name. The service name should end with ".rest"" (for XML output), or ".json" (for JSON output). For exampe:

    getProjects.rest  or  getProjects.json

Those components form the base URL, and would be assembled as:

   http://www.kompoz.com/compose-collaborate/v-1.0/getProjects.json

The service name is followed by the actual query parameters, which take the form argument=value, where the arguments and values are url encoded. Multiple parameters are separated by an ampersand (&). Refer to the documentation for each service to see a list of valid arguments.

If a client chooses to use the POST method, the POST URL would include everything up to the question mark (but not including the question mark). Parameters would be passed as normal HTTP name-value pairs.

Authentication

The Kompoz API methods require authentication. For the time being, HTTP Basic Authentication is the only supported authentication scheme. When authenticating via Basic Auth, use your registered Kompoz username as the username component, and your Kompoz password as the password component. Some service operations require an additional client ID (see each operation for details).

Kompoz Services Registry

• getMember : Get details about a member

• createProject : Create a new project
• getProject : Get details about a project
• getProjects : List projects by keyword and member
• searchProjects : Search projects by keyword, tags, and members
• getNewestProjects : List the newest projects (recently created)
• getFollowedProjects : List the projects followed by a given member

• getProjectTracks : Get a list of tracks for a given project
• getTrack : Get details about a single track
• putTrackFile : Request to upload a file
• putTrack : Commit a track to a project
• deleteTrack : Delete a track from a project

• searchSongs : Search finished songs
• getSong : Get details about a finished song
• licenseSong : License (purchase) a song for commercial use

• getStations : Get a list of radio stations created by the calling member.
• deleteStation : Delete a radio station.
• getStationNextSong : Get the next song to be played/streamed for the given radio station.
• getPodcasts : Get a list of published podcasts.
• getPodcast : Get podcast details

• getTrackTypes : Get a list of valid track types
• getTagTypes : Get a list of all possible tag codes/descriptions (categories).
• getTags : Get a list of all possible tag values.
• getLicenses : Get a list of licenses

• getInboxMessages : Get inbox messages
• getMessage : Get (read) an inbox message
• deleteMessage : Delete an inbox message

• Error Handling

Looking for additional Web services? Contact us with details about what you need. Chances are, we'll build it for you.