Getting started with programmatic access

Job Dispatcher provides programmatic access to data resources and analysis tools via Web Services technologies, which are built on open standards, such as:

• Representational state transfer (REST): a software architecture style.

• Hypertext Transfer Protocol Secure (HTTPS): an application-layer protocol for transmitting data.

Fair-use policy

We kindly ask all users of Job Dispatcher services to submit jobs in batches of no more than 30 at a time and not to submit more until the results and processing are complete.

Warning

We kindly ask all users of EMBL-EBI Web Services to submit tool jobs in batches of no more than 30 at a time and not to submit more until the results and processing is complete. Please ensure that a valid email address is provided. Excessive usage of a particular resource will be dealt with in accordance with EMBL-EBI's Terms of Use. Please contact us if you need further information.

Chinese / 中文

敬告所有 EMBL-EBI Web Services 网络服务用户，请在呈交工具工作时，每批工作 不要超过30项， 并请您在该批数据的结果和处理程序完成之后再呈交下一批工作。并请您提供一个有效的电子邮件地址。 超额使用某项资源将按照 EMBL-EBI使用条款处理。 如需进一步信息， 请通过此链接 与我们联系。

Korean / 한글

EMBL-EBI 웹서비스는 다량의 데이터(배치 등) 호출시, 사용자당 실시간으로 최대 30건의 처리를 제한적으로 사용하실 것을 권고드리고 있습니다. 보내신 건이 완료되기 전에, 재차 더 많은 데이터가 전송되지 않도록 협조 부탁드립니다. 또한 유효한 메일주소를 사용해주시기 바랍니다. 다량의 데이터 사용에 관한, EMBL-EBI 이용 약관을 준수해 주실것을 부탁드리며, 관련해 도움이 필요하시면, 문의 주시기 바랍니다.

OpenAPI

The OpenAPI Specification, previously known as the Swagger Specification, is a specification for a machine-readable interface definition language for describing, producing, consuming and visualizing RESTful web services.

Explore the Job Dispatcher REST API with the intuitive Swagger UI below. Simply select a tool of interest and click to expand the endpoints. By clicking on the expanded endpoints you can even try them out.

Choose a Tool

Choose a Tool Clustal Omega EMBOSS cons Kalign MAFFT MUSCLE MView PRANK T-Coffee EMBOSS matcher EMBOSS needle EMBOSS stretcher EMBOSS water GeneWise LALIGN SSEARCH2SEQ GGSEARCH2SEQ PromoterWise Wise2DBA Simple Phylogeny InterProScan 5 PfamScan Phobius Pratt RADAR HMMER3 hmmscan HMMER3 phmmer Infernal cmscan R2DT EMBOSS seqret seqcksum FASTA FASTM NCBI BLAST+ PSI-BLAST PSI-Search PSI-Search2 EMBOSS cpgplot EMBOSS isochore EMBOSS newcpgreport EMBOSS pepinfo EMBOSS pepstats EMBOSS pepwindow EMBOSS dotmatcher EMBOSS dotpath EMBOSS dottup EMBOSS polydot SAPS EMBOSS backtranambig EMBOSS backtranseq EMBOSS sixpack EMBOSS transeq

Clients

Example command-line (CLI) clients, are provided for Job Dispatcher RESTful APIs. These are provided in a number of programming languages, namely Python, Perl and Java. Instructions on how to download the clients and how to use them are provided in the clients' GitHub repository.

These clients are generated from the APIs directly with a Python application webservice-clients-generator.

Running the clients

Download the clients or clone the repository:

Clone the repository

git clone https://github.com/ebi-wp/webservice-clients.git

Perl clients

In order to run Perl clients, Perl (tested version 5.22.0) needs to installed as well as Perl dependencies. Install dependencies with:

To install Perl dependencies run (you might need sudo)

cpan LWP
cpan XML::Simple
cpan YAML::Syck

An example test for Clustal Omega Perl client

perl clustalo.pl --email <your@email.com> --sequence sp:wap_rat,sp:wap_mouse,sp:wap_pig

Python clients

Specially if you have no root access to your machine, you might need to use virtualenv. Prepare a virtual environment where all the Python (tested version 3.6.5) dependencies will be installed.

virtualenv -p `which python` env
source ./env/bin/activate

Install dependencies with

pip install --upgrade pip xmltramp2 requests

An example test for Clustal Omega Python client

python clustalo.py --email <your@email.com> --sequence sp:wap_rat,sp:wap_mouse,sp:wap_pig

Java clients

In order to run Java clients, OpenJDK 8 (tested version 1.8.0_161") as well as ant (tested version 1.10.5), needs to installed. Note OpenJDK 9 and above are currently not supported. The clients are provided here as self-contained JAR files. (The source code is available in the webservice-clients-generator repository). To run them on all platforms, an example for the Clustal Omega Java client is:

java -jar clustalo.jar --email <your@email.com> --sequence sp:wap_rat,sp:wap_mouse,sp:wap_pig

On Linux and OSX you can use the simpler:

./clustalo.jar --email <your@email.com> --sequence sp:wap_rat,sp:wap_mouse,sp:wap_pig

Docker

Docker is a set of platform as a service product that use OS-level virtualization to deliver software in packages called containers

We provide a Docker container with all our example clients pre-installed. To learn to pull our Docker image and run the clients with Docker refer to the information provided in our GitHub repository.

CWL

The Common Workflow Language is a standard for describing computational data-analysis workflows.

In addition to these clients uwe provide example Common Workflow Language (CWL) tool definitions as well as example CWL workflows. To learn more about CWL and how to use them please refer to the information provided in our GitHub repository.

Dbfetch

Dbfetch provides a common interface to database entry retrieval in a variety of different formats. Example clients and CWL files are provided for programmatically accessing Dbfetch.

Additional information on how to retrieve entries from Dbfetch programmatic is provided on the Dbfetch URL Synthax page.