The API clients provide a way to use Synapse programmatically. This page shows you how to install a client and login to Synapse programmatically. Packages to interface and access data within Synapse are available for:
Command Lineline
Python
R
To manage stored login credentials, visit the Client Configuration pagesee /wiki/spaces/DOCS/pages/1985446156.
Command Line
The Synapse command line client is implemented in Python and comes with the Synapse Python package. To install the Synapse command line client, please make sure that you have Python
and pip
installed. Instruction on Python
installation Instruction on pip
installationAfter installing pip
and python
, in have Python and pip installed. For more information, see the Python and pip installation instructions.
After installing Python and pip, open your terminal (Mac OS or GNU/Linux) or Command Prompt (Windows), and run the following command:
Code Block | ||
---|---|---|
| ||
pip install synapseclient synapse login "username" "password" synapse -h |
For more documentation on the command line client, see the synapseclient
docssynapseclient docs.
Python
The synapseclient
package is available to use Python to access Synapse. See the Python client docs for supported versions of Python.
Code Block | ||
---|---|---|
| ||
pip install synapseclient |
For complete documentation of the Python client, visit the synapseclient
docssynapseclient docs.
R
The synapser
package is available for R version versions 3.4 and 3.5.
Code Block | ||
---|---|---|
| ||
install.packages("synapser", repos=c("http://ran.synapse.org", "httphttps://crancloud.fhcrcr-project.org")) install.packages("synapser") library(synapser) synLogin("username", "password") |
For more documentation on the R client, see synapser
R synapser R docs.
To Report an Issue
Report client-specific issues or bugs at the R client or Python (including the command line client) GitHub Issues issues pages. If you have questions on how to use the clients to interact with Synapse, please ask in visit the Synapse Help Forum.
...