Stevan/onspring-api-sdk-python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
StevanFreeborn
2022-05-03 09:00:26 -05:00
parent ba104736dd
commit 3ce836f6d6
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6
View File
@@ -7,6 +7,8 @@ This is an unofficial SDK for the Onspring API. It was not built in consultation
This SDK was developed independently using their existing C# SDK as a guide and with the intention of making development of integrations done in Python with an Onspring instance quicker and more convenient. This SDK was developed independently using their existing C# SDK as a guide and with the intention of making development of integrations done in Python with an Onspring instance quicker and more convenient.
## Dependencies
## Installation ## Installation
Install the SDK using pip: Install the SDK using pip:
@@ -25,6 +27,8 @@ In order to successfully interact with the Onspring Api you will need an API key
## Start Coding ## Start Coding
### `OnspringClient`
The most common way to use the SDK is to create an OnspringClient instance and call its methods. Its constructor requires two parameters: The most common way to use the SDK is to create an OnspringClient instance and call its methods. Its constructor requires two parameters:
- `baseUrl` - currently this should always be: `https://api.onspring.com` - `baseUrl` - currently this should always be: `https://api.onspring.com`
@@ -55,6 +59,8 @@ url = cfg['prod']['url']
client = OnspringClient(url, key) client = OnspringClient(url, key)
``` ```
### `ApiResponse`
## Full API Documentation ## Full API Documentation
You may wish to refer to the full [Onspring API documentation](https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf) when determining which values to pass as parameters to some of the `OnspringClient` methods. There is also a [swagger page](https://api.onspring.com/swagger/index.html) that you can use for making exploratory requests. You may wish to refer to the full [Onspring API documentation](https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf) when determining which values to pass as parameters to some of the `OnspringClient` methods. There is also a [swagger page](https://api.onspring.com/swagger/index.html) that you can use for making exploratory requests.