iNode API

The iNode API allows you to programmatically access your traffic data, devices, and links. This page covers everything you need to get started - from authenticating your requests to running full API examples in multiple languages. Whether you're integrating iNode into an existing system or building a custom workflow, the sections below will walk you through the setup step by step.

Authentication

iNode supports two authentication methods: OAuth2 and API Key. Choose the method that best fits your setup. OAuth2 is recommended for applications that need token refresh capabilities, while the API Key method is simpler and ideal for quick integrations.

OAuth2

To use OAuth2, contact the SMATS support team to receive your client_id and client_secret, which will be linked to your account.

Once you have those credentials, you can use your company owner account's username and password alongside the client_id and client_secret to retrieve an access token.

Examples

cURL

curl --location --request POST 'https://inode.smatstraffic.com/api/oauth/token/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=<username>' \
--data-urlencode 'password=<password>' \
--data-urlencode 'client_secret=<client secret>' \
--data-urlencode 'client_id=<client id>' \
--data-urlencode 'scope=sync'

Python

Build the authentication body as shown below. Note that the content-type must be set to application/x-www-form-urlencoded.

auth_body = {
'grant_type': 'password',
'username': USERNAME,
'password': PASSWORD,
'client_id': CLIENT_ID,
'client_secret': CLIENT_SECRET,
'scope': 'sync'
}

auth_response = requests.post("https://inode.smatstraffic.com/api/oauth/token/", data=auth_body)
auth_response_json = auth_response.json()
access_token = auth_response_json['access_token']
refresh_token = auth_response_json['refresh_token']

API Key

The API Key method is the simplest way to access the iNode API. To retrieve your key, navigate to Settings > My Profile > API Access in the iNode dashboard and copy the key shown there.

Important Note

Only iNode users with the Owner role can access the API Key from the dashboard.

Once you have your API Key, include it in the Authorization header of every request you send to the iNode API, as shown in the examples below.

Examples

The examples below are making a get request to the iNode v1 endpoint for retrieving the links.

cURL

curl 'https://inode.smatstraffic.com/api/v1/links/' -H 'Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxx'

Python

import requests
headers = {
'Authorization': 'Token xxxxxxxxxxxxxxxxxxxxxxxxxxx'
}
response = requests.get('https://inode.smatstraffic.com/api/v1/links/', headers=headers)

PHP

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://inode.smatstraffic.com/api/v1/links/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxx';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
}
curl_close($ch);

GO

req, err := http.NewRequest("GET", "https://inode.smatstraffic.com/api/v1/links/", nil)
if err != nil {
// handle err
}
req.Header.Set("Authorization", "Token xxxxxxxxxxxxxxxxxxxxxxxx")
resp, err := http.DefaultClient.Do(req)
if err != nil {
// handle err
}
defer resp.Body.Close()

API example

The following Python examples show how to make authenticated API calls to retrieve your links and devices. Two versions are provided - one for each authentication method. Both examples retrieve the full list of links and devices every minute in a loop.

OAuth2 Authentication

Use this example if you authenticated using the OAuth2 method. This includes logic for refreshing your access token automatically when it expires (after 5 days).

Start by defining your credentials and endpoint URLs:

Python

import requests
from time import sleep

USERNAME = '<company owner username>'
PASSWORD = '<company owner password>'
CLIENT_ID = '<client id>'
CLIENT_SECRET = '<client secret>'
SCOPE = 'sync'

BASE_URL = "https://inode.smatstraffic.com/api/"
AUTH_URL = BASE_URL + "oauth/token/"
V1_URL = BASE_URL + "v1/"
LINKS_URL = V1_URL + "links/"
DEVICES_URL = V1_URL + "devices/"

auth_body = {
    'grant_type': 'password',
    'username': USERNAME,
    'password': PASSWORD,
    'client_id': CLIENT_ID,
    'client_secret': CLIENT_SECRET,
    'scope': SCOPE
}

Important Note

The content-type must be application/x-www-form-urlencoded.

Next, authenticate and store your tokens. The get_new_token function handles refreshing when the access token expires:

auth_response = requests.post(AUTH_URL, data=auth_body)

if auth_response.status_code != 200:
print(auth_response.json())
print('failed to authenticate')
exit(-1)

auth_response_json = auth_response.json()
access_token = auth_response_json['access_token']
refresh_token = auth_response_json['refresh_token']

authorized_header = {
    'Authorization': 'Bearer %s' % access_token
}

def get_new_token(refresh_tok):
    global authorized_header, access_token, refresh_token
    auth_refresh_body = {
        'grant_type': 'refresh_token',
        'client_id': CLIENT_ID,
        'client_secret': CLIENT_SECRET,
        'refresh_token': refresh_tok
}
auth_response = requests.post(AUTH_URL, data=auth_refresh_body)

if auth_response.status_code != 200:
    print('failed to refresh token')
    exit(-1)

auth_response_json = auth_response.json()
# retrieve new access_token
access_token = auth_response_json['access_token']
refresh_token = auth_response_json['refresh_token']
# update the header with a new access token
authorized_header = {
    'Authorization': 'Bearer %s' % access_token
}

With authentication set up, the loop below retrieves your links and devices every 60 seconds. If the token has expired (401 response), it automatically refreshes before continuing:

while True:
    # retrieve the list of the links (without pagination)
    links_response = requests.get(LINKS_URL + '?no_pagination', headers=authorized_header)
    if links_response.status_code == 401:
        # access token gets expired after 5 days
        # so we can use refresh_token to get a new access_token
        get_new_token(refresh_token)
        # new access_token is retrieved - continue the loop
        continue
    links_response_json = links_response.json()
    # print list of all links in your company
    print(links_response_json)

    # retrieve the list of the devices (without pagination)
    devices_response = requests.get(DEVICES_URL + '?no_pagination', headers=authorized_header)
    devices_response_json = devices_response.json()
    # print list of all devices in your company
    print(devices_response_json)

sleep(60)

API Key Authentication

If you've retrieved your API Key from iNode > Settings > Profile > API Access (Owner only), use the following example instead. This approach is simpler - no token management is required.

Set up your endpoint URLs and include your API Key in the header:

Python

import requests

BASE_URL = "https://inode.smatstraffic.com/api/"
AUTH_URL = BASE_URL + "oauth/token/"
V1_URL = BASE_URL + "v1/"
LINKS_URL = V1_URL + "links/"
DEVICES_URL = V1_URL + "devices/"

API_ACCESS_KEY = '<---api key retrieved from iNode profile page of the owner--->'

header = {
    'Authorization': 'Token %s' % API_ACCESS_KEY
}

Then run the loop to retrieve your links and devices every 60 seconds:

while True:
    # retrieve the list of the links (without pagination)
    links_response = requests.get(LINKS_URL + '?no_pagination', headers=header)
    links_response_json = links_response.json()
    # print list of all links in your company
    print(links_response_json)

    # retrieve the list of the devices (without pagination)
    devices_response = requests.get(DEVICES_URL + '?no_pagination', headers=header)
    devices_response_json = devices_response.json()
    # print list of all devices in your company
    print(devices_response_json)

    sleep(60)

Swagger documentation

iNode's full API reference is available through the Swagger documentation. You can access it here.

Important Note

You must be logged into iNode to access the Swagger documentation.

Table of contents

iNode API
Authentication
OAuth2
Examples
cURL
Python
API Key
Examples
cURL
Python
PHP
GO
API example
OAuth2 Authentication
Python
API Key Authentication
Python
Swagger documentation