12. Programmers Guide¶
12.1. GraphSpace REST API¶
Note: In order to fully utilize the features of GraphSpace REST API, you must have an account on GraphSpace.
12.1.1. Why use GraphSpace REST API ?¶
The GraphSpace REST API makes it easier than ever to use GraphSpace in new and exciting ways, such as creating external applications on top of GraphSpace. For example,
- Create a Cytoscape plugin which will allow users to transfer networks between GraphSpace and Cytoscape.
- Users can also automate the way they upload graphs to GraphSpace.
The scope of what can be done with the GraphSpace REST API is only limited by our imagination. Overall, if a user want a structured, extensible, and simple way to get data in and out of GraphSpace over HTTP, they should probably use the GraphSpace REST API.
12.1.2. Base URL¶
All URLs referenced in the documentation have the following base:
12.1.3. API Reference¶
The GraphSpace software also includes a simple yet powerful Python library called
graphspace python that allows a user to rapidly construct a network, add nodes and edges, modify their visual styles, and then upload the network, all within tens of lines of code. Moreover, the user need not know the details of the REST API to use this module. It is very easy to integrate this library into a user’s software pipeline.
Install graphspace_python from PyPI using:
pip install graphspace_python