Personal tools

From HEXONET Wiki

Jump to: navigation, search
(→‎Shell based mode)
(→‎Mac OS)
 
(22 intermediate revisions by one user not shown)
Line 1: Line 1:
 
{{Sidebar}}
 
{{Sidebar}}
−
<div style="font-size: 160%;">ISPAPI Commandline interface</div>
+
<div style="font-size: 160%;">ISPAPI Command-line interface</div>
  
  
Line 6: Line 6:
  
  
−
ISPAPI is a new simple commandline interface connected with your Hexonet account allowing you to deal with the system via API Commands. ISPAPI is now available for LINUX and will be available for WINDOWS and MAC OS shortly.
+
ISPAPI is a new simple command-line interface connected with your Hexonet account allowing you to deal with the system via API Commands.<br>
  
−
Our new tool supports graphical and shell based mode.
+
Our new tool supports graphical and shell based mode and is available for LINUX, WINDOWS and MAC OS.
  
−
==DOWNLOAD==
+
==Download==
−
===LINUX VERSION for UBUNTU and DEBIAN===
+
===Linux (Ubuntu and Debian)===
−
'''Latest version:''' [https://www.hexonet.net/files/ispapi-cli/ispapi_latest_all.deb ISPAPI Commandline interface (Version 1.0.3, 2014-08-18)]
+
'''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)]
 
<br><br>
 
<br><br>
−
==How to install it?==
 
  
−
===Over shell===
+
===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)]
 +
<br><br>
 +
 
 +
===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)]
 +
<br><br>
 +
 
 +
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>
 +
<br>
 +
 
 +
==Installation==
 +
===Linux===
 +
 
 +
====Over shell====
 
<code>sudo dpkg -i ispapi_latest_all.deb</code>
 
<code>sudo dpkg -i ispapi_latest_all.deb</code>
 
<br><br>
 
<br><br>
−
===Over the Software-Center===
+
====Over the Software-Center====
 
Launch the downloaded "ispapi_latest_all.deb" file and install it.
 
Launch the downloaded "ispapi_latest_all.deb" file and install it.
 
<br><br>
 
<br><br>
Line 25: Line 46:
 
<br><br>
 
<br><br>
  
−
==How to use it?==
+
===Windows===
 +
No installation needed, unzip the ZIP file and launch "ispapi.exe".
 +
<br><br>
  
−
===Graphical mode===
+
===Mac OS===
 +
Open the "ispapi_latest.dmg" and drag and drop the "ispapi" application file where you want.
 +
<br><br>
 +
[[File:Climacos1.png|300px|Mac OS installer]]
 +
<br><br>
 +
 
 +
==Use==
 +
===Linux===
 +
 
 +
====Graphical mode====
 
<code>ispapi --gui</code><br><br>
 
<code>ispapi --gui</code><br><br>
  
−
[[File:cli.png|600px|ISPAPI Commandline interface - Graphical mode]]
+
[[File:linux_sc_106.png|600px|ISPAPI Command-line interface - Graphical mode]]
 
<br><br>
 
<br><br>
 
Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.
 
Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.
 
<br><br>
 
<br><br>
  
−
===Shell based mode===
+
====Shell based mode====
 
<code>ispapi --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 
<code>ispapi --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 
<br><br>
 
<br><br>
Line 51: Line 83:
 
Example:
 
Example:
 
<code>ispapi checkdomain mydomain.com</code>
 
<code>ispapi checkdomain mydomain.com</code>
 +
<br><br>
 +
 +
===Windows===
 +
====Graphical mode====
 +
Launch the "ispapi.exe" application or launch it over the command-line:
 +
<code>ispapi.exe --gui</code><br><br>
 +
 +
[[File:win_sc_106.JPG|600px|ISPAPI Command-line interface - Graphical mode]]
 +
<br><br>
 +
Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.
 +
<br><br>
 +
 +
====Shell based mode====
 +
<code>ispapi.exe --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 +
<br><br>
 +
More details available with: <code>ispapi.exe --help</code>
 +
<br><br>
 +
Example:
 +
<code>ispapi.exe --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com</code>
 +
<br><br>
 +
[[File:Cliwin2.JPG|700px|ISPAPI Commandline interface - Shell based mode]]
 +
<br><br>
 +
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>
 +
<br><br>
 +
Example:
 +
<code>ispapi.exe checkdomain mydomain.com</code>
 +
<br><br>
 +
 +
===Mac OS===
 +
====Graphical mode====
 +
Launch the "ispapi" application or launch it over the command-line:<br>
 +
<code>cd ispapi.app/Contents/Resources/</code><br>
 +
<code>./ispapi.py --gui</code><br><br>
 +
 +
[[File:mac_sc_106.png|600px|ISPAPI Command-line interface - Graphical mode]]
 +
<br><br>
 +
Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.
 +
<br><br>
 +
 +
====Shell based mode====
 +
<code>cd ispapi.app/Contents/Resources/</code><br>
 +
<code>./ispapi.py --login=test.user --password=test.passw0rd --entity=1234 [command]</code>
 +
<br><br>
 +
More details available with: <code>./ispapi.py --help</code>
 +
<br><br>
 +
Example:
 +
<code>./ispapi.py --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com</code>
 +
<br><br>
 +
[[File:Climacos3.png|750px|ISPAPI Commandline interface - Shell based mode]]
 +
<br><br>
 +
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>
 +
<br><br>
 +
Example:
 +
<code>./ispapi.py checkdomain mydomain.com</code>
 
<br><br>
 
<br><br>

Latest revision as of 16:27, 12 August 2016

ISPAPI Command-line interface


Contents

 [hide] 


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.

[edit] Download

[edit] Linux (Ubuntu and Debian)

Latest version: ISPAPI Command-line interface (Version 1.0.9, 2016-08-11)

[edit] Windows

Latest version: ISPAPI Command-line interface (Version 1.0.8, 2015-06-12)

[edit] Mac OS

Latest version: ISPAPI Command-line interface (Version 1.0.8, 2015-06-12)

The latest release includes the following fixes:

  • Fixed to work with Ubuntu 16.04
  • Bug fixes in the command parsing
  • Clear button
  • New GUI - Split screen (command and response on the same screen)
  • Various usability optimizations
  • Copy/Paste functionality also working on MAC OS now


[edit] Installation

[edit] Linux

[edit] Over shell

sudo dpkg -i ispapi_latest_all.deb

[edit] Over the Software-Center

Launch the downloaded "ispapi_latest_all.deb" file and install it.

Ubuntu Software-Center

[edit] Windows

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

[edit] Mac OS

Open the "ispapi_latest.dmg" and drag and drop the "ispapi" application file where you want.

Mac OS installer

[edit] Use

[edit] Linux

[edit] Graphical mode

ispapi --gui

ISPAPI Command-line interface - Graphical mode

Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.

[edit] Shell based mode

ispapi --login=test.user --password=test.passw0rd --entity=1234 [command]

More details available with: ispapi --help

Example: ispapi --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com

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: ispapi [command]

Example: ispapi checkdomain mydomain.com

[edit] Windows

[edit] Graphical mode

Launch the "ispapi.exe" application or launch it over the command-line: ispapi.exe --gui

ISPAPI Command-line interface - Graphical mode

Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.

[edit] Shell based mode

ispapi.exe --login=test.user --password=test.passw0rd --entity=1234 [command]

More details available with: ispapi.exe --help

Example: ispapi.exe --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com

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: ispapi.exe [command]

Example: ispapi.exe checkdomain mydomain.com

[edit] Mac OS

[edit] Graphical mode

Launch the "ispapi" application or launch it over the command-line:
cd ispapi.app/Contents/Resources/
./ispapi.py --gui

ISPAPI Command-line interface - Graphical mode

Go to „Settings“ → „API Credentials“ and fill your credentials. They will be saved in a profile file.

[edit] Shell based mode

cd ispapi.app/Contents/Resources/
./ispapi.py --login=test.user --password=test.passw0rd --entity=1234 [command]

More details available with: ./ispapi.py --help

Example: ./ispapi.py --login=test.user --password=test.passw0rd --entity=1234 checkdomain mydomain.com

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: ./ispapi.py [command]

Example: ./ispapi.py checkdomain mydomain.com

Retrieved from "https://wiki.hexonet.net/index.php?title=ISPAPI&oldid=6795"