Beta Unofficial
Python SDK

Quick Links

How to Build

You must have Python 2 >=2.7.9 or Python 3 >=3.4 installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.

Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.

  • Using command line, navigate to the directory containing the generated files (including requirements.txt) for the SDK.
  • Run the command pip install -r requirements.txt. This should install all the required dependencies.

Building SDK - Step 1
Building SDK - Step 1

How to Use

The following section explains how to use the Securitytextorgapi SDK package in a new project.

1. Open Project in an IDE

Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Open project in PyCharm - Step 1
Open project in PyCharm - Step 1

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

Open project in PyCharm - Step 2
Open project in PyCharm - Step 2

The project files will be displayed in the side bar as follows:

Open project in PyCharm - Step 3
Open project in PyCharm - Step 3

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PyCharm - Step 1
Add a new project in PyCharm - Step 1

Name the directory as “test”

Add a new project in PyCharm - Step 2
Add a new project in PyCharm - Step 2

Add a python file to this project with the name “testsdk”

Add a new project in PyCharm - Step 3
Add a new project in PyCharm - Step 3

Name it “testsdk”

Add a new project in PyCharm - Step 4
Add a new project in PyCharm - Step 4

In your python file you will be required to import the generated python library using the following code lines

from securitytextorgapi.securitytextorgapi_client import SecuritytextorgapiClient

Add a new project in PyCharm - Step 4
Add a new project in PyCharm - Step 4

After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.

3. Run the Test Project

To run the file within your test project, right click on your Python file inside your Test project and click on Run

Run Test Project - Step 1
Run Test Project - Step 1

How to Test

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

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Invoke pip install -r test-requirements.txt
  3. Invoke nosetests

Initialization

API client can be initialized as following.


client = SecuritytextorgapiClient()

Class Reference

List of Controllers

Class: WhoisController

Get controller instance

An instance of the WhoisController class can be accessed from the API Client.

 whois_controller = client.whois

Method: create_api_whois_query

Tags: Skips Authentication

Query the server for a Domain object

def create_api_whois_query(self,
                               body)

Parameters

ParameterTagsDescription
bodyRequiredBody of API request

Example Usage

body = RequestsQueryModel()

result = whois_controller.create_api_whois_query(body)

Errors

Error CodeError Description
400Bad Request
406Not Acceptable
500Internal Server Error

Back to List of Controllers