SensorPush Public API
Project description
sensorpush-api
This is a swagger definition for the SensorPush public REST API. Download the definition file here.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: v1.0.20240803
- Package version: 2.0.0
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import sensorpush_api
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import sensorpush_api
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import sensorpush_api
from sensorpush_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.sensorpush.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorpush_api.Configuration(
host = "https://api.sensorpush.com/api/v1"
)
# Enter a context with an instance of the API client
async with sensorpush_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = sensorpush_api.ApiApi(api_client)
access_token_request = sensorpush_api.AccessTokenRequest() # AccessTokenRequest |
try:
# Request a temporary oAuth access code.
api_response = await api_instance.access_token(access_token_request)
print("The response of ApiApi->access_token:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiApi->access_token: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.sensorpush.com/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
ApiApi | access_token | POST /oauth/accesstoken | Request a temporary oAuth access code. |
ApiApi | download | POST /reports/download | Download bulk reports. |
ApiApi | gateways | POST /devices/gateways | Lists all gateways. |
ApiApi | list | POST /reports/list | Lists reports available for download. |
ApiApi | oauth_authorize_post | POST /oauth/authorize | Sign in and request an authorization code |
ApiApi | root_post | POST / | SensorPush API status |
ApiApi | samples | POST /samples | Queries for sensor samples. |
ApiApi | sensors | POST /devices/sensors | Lists all sensors. |
ApiApi | tags_response | POST /tags | Updates tags on devices. |
ApiApi | token | POST /oauth/token | oAuth 2.0 for authorization, access, and refresh tokens |
Documentation For Models
- AccessTokenRequest
- AccessTokenResponse
- AuthorizeRequest
- AuthorizeResponse
- Error
- Gateway
- GatewaysRequest
- ListResponse
- ReportListing
- ReportsRequest
- Sample
- Samples
- SamplesRequest
- Sensor
- SensorAlerts
- SensorAlertsHumidity
- SensorAlertsTemperature
- SensorCalibration
- SensorsRequest
- Status
- Tags
- TagsRequest
- TagsResponse
- TokenRequest
- TokenResponse
Documentation For Authorization
Authentication schemes defined for the API:
oauth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
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
Built Distribution
Hashes for sensorpush_api-2.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb37a8db030f8686a2a42af5561cbbb9a13d5627d1efccc044297e5dcb2ab13a |
|
MD5 | c194eae5c34d09dc406278966eca50c2 |
|
BLAKE2b-256 | b2f6bfb6d84d02c28a5ee7aacc105f8f4f8e6af0518ec1ee94b403d792720660 |