Getting Started with CTD - Documentation

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install n-profile-sdk==2.3.4

You can also view the package at: https://pypi.python.org/pypi/n-profile-sdk/2.3.4

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

from ctddocumentation.ctddocumentation_client import CtddocumentationClient
from ctddocumentation.configuration import Environment

client = CtddocumentationClient(
    authorization='Authorization'
)

Authorization

This API uses Custom Header Signature.

List of APIs

• Tasks Queries
• Custom Attributes Categories
• Login
• Assets
• Alerts
• Tasks
• Queries
• Insights
• Sites
• Activities
• License
• Users
• Groups
• Sensors
• Events

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest