Rehive SDK for Python
Project description
# Rehive Python SDK
A tool primarly used for quick interfacing with the Rehive API.
## Install
```
pip install rehive
```
## Documentation
For more in depth api details go to: http://docs.rehive.com/
## Examples And How-to
```python
from rehive import Rehive, APIException
rehive = Rehive() # OR Rehive(API_TOKEN_HERE)
```
You can parse an api token or leave blank if manually logging in. Each object instance will store it's own token and act as another user.
The SDK will default to the live API. To easily switch to staging there is a network flag:
```python
rehive = Rehive(network='staging')
```
Login:
```python
rehive.auth.login(
user="test@rehive.com",
company="test_company",
password="12345678"
)
```
Get:
```python
rehive.admin.accounts.get()
```
Get nested objects:
```python
rehive.admin.accounts.obj('5AT24mW61H').currencies.get()
```
Get with filters:
```python
rehive.admin.transactions.get(filters={"status":"confirmed"})
```
Create:
```python
rehive.admin.users.emails.create('1d3e584d-ac56-483c-8aa5-d4ef059608ba', 'connor+899@rehive.com', verified=True)
```
Patch/Put:
```python
rehive.admin.company.switches.patch('1', enabled=True) # Patch switch with identifier 1
```
Pagination:
```python
rehive.admin.currencies.get()
rehive.admin.currencies.get_next()
rehive.admin.currencies.get_previous()
```
## Exception And Error Handling
```python
from rehive import APIException
try:
rehive.admin.currencies.get()
except APIException as e:
print(e.status_code) # Error code status code from Rehive
print(e.data) # Any custom error messages and data returned from Rehive
```
## Idempotent requests
```python
rehive.user.update(last_name='test7777', idempotent_key='{UNIQUE_KEY}')
```
A tool primarly used for quick interfacing with the Rehive API.
## Install
```
pip install rehive
```
## Documentation
For more in depth api details go to: http://docs.rehive.com/
## Examples And How-to
```python
from rehive import Rehive, APIException
rehive = Rehive() # OR Rehive(API_TOKEN_HERE)
```
You can parse an api token or leave blank if manually logging in. Each object instance will store it's own token and act as another user.
The SDK will default to the live API. To easily switch to staging there is a network flag:
```python
rehive = Rehive(network='staging')
```
Login:
```python
rehive.auth.login(
user="test@rehive.com",
company="test_company",
password="12345678"
)
```
Get:
```python
rehive.admin.accounts.get()
```
Get nested objects:
```python
rehive.admin.accounts.obj('5AT24mW61H').currencies.get()
```
Get with filters:
```python
rehive.admin.transactions.get(filters={"status":"confirmed"})
```
Create:
```python
rehive.admin.users.emails.create('1d3e584d-ac56-483c-8aa5-d4ef059608ba', 'connor+899@rehive.com', verified=True)
```
Patch/Put:
```python
rehive.admin.company.switches.patch('1', enabled=True) # Patch switch with identifier 1
```
Pagination:
```python
rehive.admin.currencies.get()
rehive.admin.currencies.get_next()
rehive.admin.currencies.get_previous()
```
## Exception And Error Handling
```python
from rehive import APIException
try:
rehive.admin.currencies.get()
except APIException as e:
print(e.status_code) # Error code status code from Rehive
print(e.data) # Any custom error messages and data returned from Rehive
```
## Idempotent requests
```python
rehive.user.update(last_name='test7777', idempotent_key='{UNIQUE_KEY}')
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rehive-1.1.9.tar.gz
(9.8 kB
view hashes)
Built Distribution
rehive-1.1.9-py3-none-any.whl
(14.2 kB
view hashes)