Skip to main content

Structured way to interface with Telstra Track and Monitor

Project description

TelstraTrackMonitorAPI

Intended to be a Structured way to interface with Telstra's Track & Monitor API.\

It mostly focuses on devices for now.

Has classes and methods for:

  • Token Management - Get/Load/save/update
  • Getting Devices with specified params

Usage

Firstly you need to make up an instance of the TokenManager Class.
This Class will be used to pass the retrieved Token to other methods later

ttm_token = TelstraTrackMonitorAPI.TokenManager(
	server='https://tapi.telstra.com'
	client_id='XXXXXXXXXXXXXXXXXXXXX'
	client_secret='XXXXXXXXXXXXXXXXXXXXX'
	save_location='ttm_token.json'
)
ttm_token.load_token() #Loads any token information in the save_location json file
ttm_token.update_token() # Check if the token is expired and renews if so.

Once the above is done we can actually pull some information from Track & Monitor API

with TelstraTrackMonitorAPI.Sessions(ttm_token.server,ttm_token.access_token) as TTM:
    ttm_devices=TTM.devices_get(
        {'$filter':'not(deviceFriendlyName eq null)'}
    )

The above method will get all devices in Track & Monitor API that have a Device Friendly name.

Installation

pip install TelstraTrackMonitorAPI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TelstraTrackMonitorAPI-0.1.8.tar.gz (5.6 kB view hashes)

Uploaded Source

Built Distribution

TelstraTrackMonitorAPI-0.1.8-py3-none-any.whl (7.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page