Difference between revisions of "Web Service"

From MusicBrainz Wiki
Jump to navigationJump to search
m
Line 2: Line 2:
   
 
[[MusicBrainz]] supports two Web Services currently:
 
[[MusicBrainz]] supports two Web Services currently:
# A new [http://en.wikipedia.org/wiki/REST REST] styled [http://www.w3.org/XML/ XML] based Web Service.
+
# /ws/2: A [http://en.wikipedia.org/wiki/REST REST] styled [http://www.w3.org/XML/ XML] based Web Service that is actively maintained and supports all the changes in the database.
# The old [http://www.w3.org/RDF/ RDF] based Web Service. [[Image:Attention.png]] '''This service is now deprecated and should NOT be used for new development!'''
+
# /ws/1: The old [http://www.w3.org/XML/ XML] based Web Service, that doesn't support all the latest changes in the schema. [[Image:Attention.png]] '''This service is now deprecated and should NOT be used for new development!'''
   
 
Read on for details on these two web services.
 
Read on for details on these two web services.
Line 15: Line 15:
 
To access the web service you can use standard XML and HTTP tools to retrieve the data, or you can use our Python based [[python-musicbrainz2]] library. [[libmusicbrainz]] version 3 and up supports the XML Web Service.
 
To access the web service you can use standard XML and HTTP tools to retrieve the data, or you can use our Python based [[python-musicbrainz2]] library. [[libmusicbrainz]] version 3 and up supports the XML Web Service.
   
[[Image:Attention.png]] '''Note''': All users of the XML web service must ensure that each of their client applications never make more than ONE web service call per second. Making more than one call per second drives up the load on the servers and prevents others from using MusicBrainz. If you impact the server by making more than one call per second, your IP address may be blocked preventing all further access to MusicBrainz.
+
[[Image:Attention.png]] '''Note''': All users of the XML web service must ensure that each of their client applications never make more than ONE web service call per second. Making more than one call per second drives up the load on the servers and prevents others from using MusicBrainz. If you impact the server by making more than one call per second, your IP address may be blocked preventing all further access to MusicBrainz.
 
==RDF Web Service==
 
 
The RDF Web Service predates the term Web Service and was developed before best practices for Web Services had been established. Consequently the Web Service is not as coherent, concise and easy to use as the XML Web Service. This Web Service should not be used for new development.
 
 
If you are using [[libmusicbrainz]] version 2.x or earlier or [[libtunepimp]] to access MusicBrainz currently, then you are using this old web service. You are strongly encouraged to migrate your existing application over to the new XML Web Service.
 
 
A exact date for scrapping this old Web Service has not been set -- we will certainly support this service through 2009. However once we move to the [[Next Generation Schema]], we well stop supporting this Web Service.
 
 
For some documentation on this Web Service see our [[RDF]] page.
 
   
 
[[Category:WikiDocs Page]] [[Category:Products]] [[Category:Development]]
 
[[Category:WikiDocs Page]] [[Category:Products]] [[Category:Development]]

Revision as of 11:57, 12 November 2011

Products > WebService

MusicBrainz supports two Web Services currently:

  1. /ws/2: A REST styled XML based Web Service that is actively maintained and supports all the changes in the database.
  2. /ws/1: The old XML based Web Service, that doesn't support all the latest changes in the schema. Attention.png This service is now deprecated and should NOT be used for new development!

Read on for details on these two web services.

XML Web Service

This new Web Service has been created to provide a modern Web Service based on the best practices established by the most used Web Services at Amazon and Google. This service uses a URL scheme using REST concepts and delivers XML responses via the standard HTTP protocol. This Web Service should be used for all new development.

The XML returned by this Web Service is documented in MusicBrainz XML Meta Data and the overall Web Service is described in XML Web Service.

To access the web service you can use standard XML and HTTP tools to retrieve the data, or you can use our Python based python-musicbrainz2 library. libmusicbrainz version 3 and up supports the XML Web Service.

Attention.png Note: All users of the XML web service must ensure that each of their client applications never make more than ONE web service call per second. Making more than one call per second drives up the load on the servers and prevents others from using MusicBrainz. If you impact the server by making more than one call per second, your IP address may be blocked preventing all further access to MusicBrainz.