ChEMBL Resources

Resources:
ChEMBL
|
SureChEMBL
|
ChEMBL-NTD
|
ChEMBL-Malaria
|
The SARfaris: GPCR, Kinase, ADME
|
UniChem
|
DrugEBIlity
|
ECBD

Wednesday, 2 October 2013

ChEMBL Web Service Update 1


Over the last the year we have be doing a lot work designing and building an API layer to the ChEMBL database. The reason for adding this programmatic interface is to simplify many of the daily tasks we carry out on the database. From a technical perspective the API is actually a series Object Relational Mapper (ORM) classes built on top of the ChEMBL database using the Python Django web framework. For many of our daily programmatic tasks we use the ORM directly, but we also expose the ORM as a RESTful Interface using Tastypie.

Some examples tools and processes currently using the new API include the ChEMBL twitter bot and the database migration process (creating PostgreSQL and MySQL versions of the ChEMBL Oracle database during the ChEMBL release cycle). We are now at the stage where we can start to think about updating some of the existing larger services to run off the new API and first of these to make the transition are the ChEMBL Web Services. So, what have we done? Essentially we have rewritten the Web Services using the API (actually we use the ORM in this case) to interact with the ChEMBL data model. We have made this new set of Web Services available under the following base URL:

https://www.ebi.ac.uk/chemblws2

Those familiar with our current Web Services will notice we have added a ‘2’, to the end. An example call the current live service looks like:


and the same call to the new Web Services looks like:


To refresh yourself on all methods we currently make available please visit the Web Service Documentation page

The new Web Service base URL will provide you with all the same methods listed on page above and more importantly the format of the results returned by the Web Services will also be the same. Our plan going forward is to run both services for next 4-6 weeks and we ask users of the current ChEMBL Web Services to test the new versions (remember you just need to add a 2) and report back any issues encountered. Assuming we do not hit any major obstacles, after the 4-6 week period we will replace the current live services with the new ChEMBL API based services.

This first Web Service update is technology focused. We want to ensure the new services scale and perform well in the wild and that our end users do not notice a change (well we are hopefully expecting you to see a performance boost). Further down the line we will make some bigger changes to the Web Services, such as reviewing methods, attributes, naming conventions, introduce paging and more. We will obviously consult the community and allow for a period of transition before releasing any such changes. Now is the time to tell us if you have any must have new ws features.

Finally, it is not strictly true that the new Web Services are identical to the current live versions. There are a couple of new features we have built in, such as improved image rendering and JSONP responses. We will blog about these in new features in the next couple of days, but in the meantime please have a look at new ChEMBL Web Services and let us know how you get on.

The ChEMBL Team

No comments: