An API for securitytext.org
How to Build
The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the
composer.json file that comes with the SDK.
To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system.
Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system.
Open command prompt and type
composer --version. This should display the current version of the Composer installed if the installation was successful.
- Using command line, navigate to the directory containing the generated files (including
composer.json) for the SDK.
- Run the command
composer install. This should install all the required dependencies and create the
vendordirectory in your project directory.
[For Windows Users Only] Configuring CURL Certificate Path in php.ini
CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:
- Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
- Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.
[curl] ; A default value for the CURLOPT_CAINFO option. This is required to be an ; absolute path. ;curl.cainfo =
How to Use
The following section explains how to use the SecuritytextOrgAPI library in a new project.
1. Open Project in an IDE
Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Open in PhpStorm to browse to your generated SDK directory and then click
2. Add a new Test Project
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a PHP file to this project
Name it "testSDK"
Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.
It is important that the path inside require_once correctly points to the file
autoload.php inside the vendor directory created during dependency installations.
After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.
3. Run the Test Project
To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.
PHP from within
Languages & Frameworks
Browse for Interpreters near the
Interpreter option and choose your interpreter.
Once the interpreter is selected, click
To run your project, right click on your PHP file inside your Test project and click on
How to Test
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
vendor\bin\phpunit --verbosefrom commandline to execute tests. If you have installed PHPUnit globally, run tests using
You can change the PHPUnit test configuration in the
API client can be initialized as following.
$client = new SecuritytextOrgAPILib\SecuritytextOrgAPIClient();
Get singleton instance
The singleton instance of the
WhoisController class can be accessed from the API Client.
$whois = $client->getWhois();
Query the server for a Domain object
||Body of API request|
$body = new RequestsQueryModel(); $result = $whois->createApiWhoisQuery($body);
|Error Code||Error Description|
|500||Internal Server Error|