Here are some useful links and basic information for software developers who are integrating GenomeSpace services with their software applications and tools. These are working documents, subject to change. We welcome feedback from early adopters / beta testers.
GenomeSpace Service Interfaces
GenomeSpace services are REST-based web services. Java-based software applications may prefer to use the GenomeSpace CDK which wraps these REST services and provides a Java API. Both of these interfaces are described in these documents:
Client Development Kit Distribution
CDK source code and pre-compiled jar can be obtained here. Java Client Development Kit (CDK) beta 4 distribution
GenomeSpace User Interface
The current version of the GenomeSpace User Interface can be found here: http://gsui.genomespace.org:8080/gsui/
GenomeSpace Server URLs
"Production" servers are intended to have the most stable GenomeSpace software, but typically that means an older version that may not have the most recent features and fixes. "Test" servers will have the most recent version. "Dev" is for developer use and subject to change at any time. The "CI" server is used for nightly builds and must not be expected to be generally available.
As GenomeSpace services evolve they will be assigned a new version when their REST interface becomes incompatible. The server URLs will change accordingly. Therefore the CDK and P2 tools should dynamically discover the GenomeSpace URLs from a text properties document. It is obtained by doing an HTTP GET from this URL:
http://www.genomespace.org/sites/genomespacefiles/config/serverurl.properties
GenomeSpace Source Code
Source code is available on Bitbucket: https://bitbucket.org/GenomeSpace/combined/overview
GenomeSpace User Accounts
GenomeSpace services require a user login. Use the GSUI for self-service account creation described here.
Alternatively, an application can use the User Registration REST service described in Identity Server RESTful API for account creation.
Reporting Bugs and Other Feedback
The GenomeSpace team appreciates your feedback. GenomeSpace is still in development, and bug reports and other feedback will help improve the quality and usability of the software.
Please report bugs and other feedback to gs-help@broadinstitute.org.
Mailing List
The GenomeSpace tool developer mailing list provides a forum where tool developers can ask questions and provide comments that might be of general interest to other early tool adopters. The GenomeSpace team also uses this mailing list for announcement and news regarding the early tool adopter program.
To sign up for the GenomeSpace tool developer mailing list, send email to gs-tool-developers-join@broadinstitute.org. The email subject and body will be ignored.