Personal tools

From HEXONET Wiki

Jump to: navigation, search
Line 36: Line 36:
 
===Windows===
 
===Windows===
 
No installation needed, just unzip the ZIP file and start "ispapi.exe".  
 
No installation needed, just unzip the ZIP file and start "ispapi.exe".  
 +
<br><br>
  
 
===Mac OS===
 
===Mac OS===
 
Open the "ispapi_latest.dmg" and drag and drop the "ispapi" application file where you want.
 
Open the "ispapi_latest.dmg" and drag and drop the "ispapi" application file where you want.
 +
<br><br>
 +
[[File:Climacos1.png|500px|Mac OS installer]]
 +
<br><br>
  
  
Line 74: Line 78:
 
Start the "ispapi.exe" application or call it via the command-line:  
 
Start the "ispapi.exe" application or call it via the command-line:  
 
<code>ispapi.exe --gui</code><br><br>
 
<code>ispapi.exe --gui</code><br><br>
 +
 +
[[File:Cliwin1.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|600px|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====
 +
Start the "ispapi" application or call it via the command-line:
 +
<code>
 +
cd ispapi.app/Contents/Resources/
 +
./ispapi.py --gui
 +
</code><br><br>
  
 
[[File:Cliwin1.JPG|600px|ISPAPI Command-line interface - Graphical mode]]
 
[[File:Cliwin1.JPG|600px|ISPAPI Command-line interface - Graphical mode]]

Revision as of 11:51, 21 August 2014

ISPAPI Command-line interface


Contents


ISPAPI is a new simple command-line 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.

Our new tool supports graphical and shell based mode.

Download

Linux (Ubuntu and Debian)

Latest version: ISPAPI Command-line interface (Version 1.0.4, 2014-08-21)

Windows

Latest version: ISPAPI Command-line interface (Version 1.0.4, 2014-08-21)

Mac OS

Latest version: ISPAPI Command-line interface (Version 1.0.4, 2014-08-21)


Installation

Linux

Over shell

sudo dpkg -i ispapi_latest_all.deb

Over the Software-Center

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

Ubuntu Software-Center

Windows

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

Mac OS

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

Mac OS installer


Use

Linux

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.

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

Windows

Graphical mode

Start the "ispapi.exe" application or call it via 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.

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

Mac OS

Graphical mode

Start the "ispapi" application or call it via 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.

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