Sro7xw: 1 revision imported

2025-03-14T10:56:32Z

1 revision imported

← Older revision	Revision as of 11:56, 14 March 2025
(No difference)

local>ImportBot: Imported from old wiki

2025-01-01T12:00:00Z

Imported from old wiki

New page

{{Sidebar}}
<div style="font-size: 160%;">ISPAPI Command-line interface</div>

__TOC__

ISPAPI is a new simple command-line interface connected with your Hexonet account allowing you to deal with the system via API Commands. 

Our new tool supports graphical and shell based mode and is available for LINUX, WINDOWS and MAC OS.

==Download==
===Linux (Ubuntu and Debian)===
'''Latest version:''' [https://www.hexonet.net/files/ispapi-cli/linux/ispapi_latest_all.deb ISPAPI Command-line interface (Version 1.0.9, 2016-08-11)]
 

===Windows===
'''Latest version:''' [https://www.hexonet.net/files/ispapi-cli/win/ispapi_latest.zip ISPAPI Command-line interface (Version 1.0.8, 2015-06-12)]
 

===Mac OS===
'''Latest version:''' [https://www.hexonet.net/files/ispapi-cli/macos/ispapi_latest.dmg ISPAPI Command-line interface (Version 1.0.8, 2015-06-12)]
 

The latest release includes the following fixes:
<ul>
<li>Fixed to work with Ubuntu 16.04</li>
<li>Bug fixes in the command parsing</li>
<li>Clear button</li>
<li>New GUI - Split screen (command and response on the same screen)</li>
<li>Various usability optimizations</li>
<li>Copy/Paste functionality also working on MAC OS now</li>
</ul>
 

==Installation==
===Linux===

====Over shell====
<code>sudo dpkg -i ispapi_latest_all.deb</code>
 
====Over the Software-Center====
Launch the downloaded "ispapi_latest_all.deb" file and install it.
 
[[File:cli3.png|500px|Ubuntu Software-Center]]
 

===Windows===
No installation needed, unzip the ZIP file and launch "ispapi.exe".
 

===Mac OS===
Open the "ispapi_latest.dmg" and drag and drop the "ispapi" application file where you want.
 
[[File:Climacos1.png|300px|Mac OS installer]]
 

==Use==
===Linux===

====Graphical mode====
<code>ispapi --gui</code> 

[[File:linux_sc_106.png|600px|ISPAPI Command-line interface - Graphical mode]]
 
Go to âSettingsâ â âAPI Credentialsâ and fill your credentials. They will be saved in a profile file.
 

====Shell based mode====
<code>ispapi --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 
More details available with: <code>ispapi --help</code>
 
Example:
<code>ispapi --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com</code>
 
[[File:cli5.png|600px|ISPAPI Commandline interface - Shell based mode]]
 
If you don't want to send your credentials with each queries, open the Graphical mode, go to âSettingsâ â âAPI Credentialsâ and fill your credentials. They will be saved in a profile file.
Once done, the saved credentials will be used for each queries and the query will look like:
<code>ispapi [command]</code>
 
Example:
<code>ispapi checkdomain mydomain.com</code>
 

===Windows===
====Graphical mode====
Launch the "ispapi.exe" application or launch it over the command-line:
<code>ispapi.exe --gui</code> 

[[File:win_sc_106.JPG|600px|ISPAPI Command-line interface - Graphical mode]]
 
Go to âSettingsâ â âAPI Credentialsâ and fill your credentials. They will be saved in a profile file.
 

====Shell based mode====
<code>ispapi.exe --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 
More details available with: <code>ispapi.exe --help</code>
 
Example:
<code>ispapi.exe --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com</code>
 
[[File:Cliwin2.JPG|700px|ISPAPI Commandline interface - Shell based mode]]
 
If you don't want to send your credentials with each queries, open the Graphical mode, go to âSettingsâ â âAPI Credentialsâ and fill your credentials. They will be saved in a profile file.
Once done, the saved credentials will be used for each queries and the query will look like:
<code>ispapi.exe [command]</code>
 
Example:
<code>ispapi.exe checkdomain mydomain.com</code>
 

===Mac OS===
====Graphical mode====
Launch the "ispapi" application or launch it over the command-line: 
<code>cd ispapi.app/Contents/Resources/</code> 
<code>./ispapi.py --gui</code> 

[[File:mac_sc_106.png|600px|ISPAPI Command-line interface - Graphical mode]]
 
Go to âSettingsâ â âAPI Credentialsâ and fill your credentials. They will be saved in a profile file.
 

====Shell based mode====
<code>cd ispapi.app/Contents/Resources/</code> 
<code>./ispapi.py --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 
More details available with: <code>./ispapi.py --help</code>
 
Example:
<code>./ispapi.py --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com</code>
 
[[File:Climacos3.png|750px|ISPAPI Commandline interface - Shell based mode]]
 
If you don't want to send your credentials with each queries, open the Graphical mode, go to âSettingsâ â âAPI Credentialsâ and fill your credentials. They will be saved in a profile file.
Once done, the saved credentials will be used for each queries and the query will look like:
<code>./ispapi.py [command]</code>
 
Example:
<code>./ispapi.py checkdomain mydomain.com</code>

ISPAPI - Revision history

Sro7xw: 1 revision imported

local>ImportBot: Imported from old wiki