Help:WikiPathways Webservice

From WikiPathways

(Difference between revisions)
Jump to: navigation, search
Line 3: Line 3:
|__TOC__
|__TOC__
|}
|}
-
= Webservice documentation =
+
= The WikiPathways web service =
WikiPathways can be accessed through a [[wikipedia:SOAP|SOAP]] webservice. This page contains documentation for the webservice API.
WikiPathways can be accessed through a [[wikipedia:SOAP|SOAP]] webservice. This page contains documentation for the webservice API.
-
== WSDL ==
+
== Getting Started ==
-
The WSDL file for the WikiPathways webservice can be downloaded from:
+
The web service is described in a WSDL file that can be downloaded from:
-
[http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl]
+
[http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl]
 +
 
 +
=== Java libraries for WikiPathways ===
 +
'''Coming soon'''
 +
 
 +
* [http://svn.bigcat.unimaas.nl/pathvisio/trunk/ PathVisio libraries]
 +
* [http://svn.bigcat.unimaas.nl/pathvisio/trunk/tools/wikipathways-client wikipathways-client]
 +
 
 +
=== Working with GPML ===
 +
The pathways on WikiPathways are stored in the GPML format. This is an XML format and can be processed in any programming language. See [http://www.pathvisio.org/EverythingGPML here] for the GPML specification.
 +
 
 +
=== SOAP libraries ===
 +
For most programming languages, libraries exist to make working with SOAP web service easier. Below is a short list of SOAP libraries for popular programming languages that might help you work with the WikiPathways web service.
 +
 
 +
* Java:
 +
** [http://ws.apache.org/axis/java/index.html Apache Axis]
 +
** See the [[#java|Java section]] for information on writing Java tools for the web service
 +
* Perl:
 +
** [http://www.soaplite.com/ SOAP::Lite]
 +
* Php:
 +
** [http://nl.php.net/soap SOAP] (official php soap library)
 +
** [http://phpsoaptoolkit.sourceforge.net/phpsoap/ PHP-SOAP]
 +
* Python:
 +
** [http://pywebsvcs.sourceforge.net/ SOAPpy]
 +
** [http://trac.optio.webfactional.com/ soaplib]
== Examples ==
== Examples ==
-
=== Java ===
+
=== Scripts ===
-
Check out [http://svn.bigcat.unimaas.nl/pathvisio/trunk/tools/soap-axis2/ the subversion repository] for example code on how to call the webservice from Java with [http://ws.apache.org/axis2/ Apache Axis 2].
+
'''Coming soon:''' small example scripts in various languages.
-
=== Taverna ===
+
 
 +
=== Web applications ===
 +
* [http://137.120.14.13:8180/wikipathways-search/WikiPathwaysSearch.html Searching WikiPathways]
 +
* [http://137.120.14.13:8180/atlas-mapper/AtlasMapper.html Visualize gene expression information]
 +
 
 +
=== Workflows ===
You can use the WikiPathways webservice to integrate WikiPathways functions in your Taverna workflows. See [http://www.myexperiment.org/packs/30 myexperiment.org] for a set of example workflows that show how to call WikiPathways from Taverna.
You can use the WikiPathways webservice to integrate WikiPathways functions in your Taverna workflows. See [http://www.myexperiment.org/packs/30 myexperiment.org] for a set of example workflows that show how to call WikiPathways from Taverna.
 +
 +
=== Extending existing software ===
 +
See the [http://www.pathvisio.org/Cytoscape_plugin Cytoscape plugin] for an example on how to use the web service to extend the functionality of existing software. You can install the plugin in your local Cytoscape installation from the [http://www.cytoscape.org/cgi-bin/moin.cgi/Cytoscape_User_Manual/Plugins plug-in manager].
 +
 +
=== Bots ===
== API Reference ==
== API Reference ==
-
[[{{FULLPAGENAME}}/API|API reference]]
+
See the [[{{FULLPAGENAME}}/API|API reference]] page for a list of available web service functions and data structures.
 +
 
 +
-----
<p>[[:Help:Contents|Return to Help Contents]]</p>
<p>[[:Help:Contents|Return to Help Contents]]</p>
<p>[[:Help:Frequently_Asked_Questions|Continue to FAQ]]</p>
<p>[[:Help:Frequently_Asked_Questions|Continue to FAQ]]</p>

Revision as of 14:09, 9 December 2008

Contents

The WikiPathways web service

WikiPathways can be accessed through a SOAP webservice. This page contains documentation for the webservice API.

Getting Started

The web service is described in a WSDL file that can be downloaded from:

http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl

Java libraries for WikiPathways

Coming soon

Working with GPML

The pathways on WikiPathways are stored in the GPML format. This is an XML format and can be processed in any programming language. See here for the GPML specification.

SOAP libraries

For most programming languages, libraries exist to make working with SOAP web service easier. Below is a short list of SOAP libraries for popular programming languages that might help you work with the WikiPathways web service.

Examples

Scripts

Coming soon: small example scripts in various languages.

Web applications

Workflows

You can use the WikiPathways webservice to integrate WikiPathways functions in your Taverna workflows. See myexperiment.org for a set of example workflows that show how to call WikiPathways from Taverna.

Extending existing software

See the Cytoscape plugin for an example on how to use the web service to extend the functionality of existing software. You can install the plugin in your local Cytoscape installation from the plug-in manager.

Bots

API Reference

See the API reference page for a list of available web service functions and data structures.



Return to Help Contents

Continue to FAQ

Personal tools