Project description

NAble Data Extraction API wrapper/Library

This is a Python wrapper/library for the NAble Data Extraction API. The NAble API returns data in xml format, this tool will convert those to lists and dictionaries for ease of use.

The official API documentation from NAble can be found here. I have tried to keep my naming scheme similar to theirs.

NOTE:

This is still in extremely early stages of development, function names may change!
Most functions have docstrings, but proper documentation has not yet been created.

I don't know how to make this yet, so it's Coming Soon

Installation

pip install NAbleAPI

Getting Started

To use the NAble API, you will need to know your region and have an API key.

Import the package
Get an API key. Follow these instructions to get your API key.
Find your region (see below)

Regions

To find your region, check this page or view table below.

Notes:

Not all regions have been tested, if your region is marked 'untested' on the table below, please let me know whether it works.
If your dashboard URL starts with www2, assume it is just www for the region.
If there is another abbreviation or country code you would like added, let me know!

Dashboard URL	Region	Status
www.am.remote.management	americas, ams	Untested
wwwasia.system-monitor.com	asia	Untested
www.system-monitor.com	australia, au, aus	Untested
wwweurope1.systemmonitor.eu.com	europe, eu	Untested
wwwfrance.systemmonitor.eu.com	france, fr	Untested
wwwfrance1.systemmonitor.eu.com	france1, fr1	Untested
wwwgermany1.systemmonitor.eu.com	germany, de, deu	Untested
wwwireland.systemmonitor.eu.com	ireland, ie, irl	Untested
wwwpoland1.systemmonitor.eu.com	poland, pl,pol	Untested
www.systemmonitor.co.uk	united kingdom, uk, gb, gbr	Verified
www.systemmonitor.us	united states, us, usa	Untested

Using the package

Create a new .py file in the root directory and import the NAble package

from NAbleAPI import NAble

Authenticate with your API key

na = NAble('[YOUR REGION]','[YOUR API KEY]')

Example

na = NAble('uk','f821213a8d3q43843dj39824')

(Not a real API key, don't try to use it)

Make your first request

Gee it sure would be helpful is there was documentation for the available commands. Unfortunately, there isn't right now.

Get all your clients

myNAbleClients = na.clients()

Storing your key

It's probably best not to store your API key in your script. Instead, you can create a .env file and use that.

Create a new file called .env in the root directory
Put your API key in it (do not put it in quotes, type exactly as shown below)

NABLE_KEY = f821213a8d3q43843dj39824

Get the key from file

from NAbleAPI import NAble # Import the NAble package
import os # Import OS package (built into Python, I'm like 99% sure)

NABLE_KEY = os.getenv("NABLE_KEY")

na = NAble('uk',NABLE_KEY)

API Endpoints

The endpoints are grouped by category on NAble's website, so I have done the same below. I found the names on NAbles site to be a bit long, so I have shortened them a bit. The Function Name is what you will use in Python. I'm doing my best to get them all added!