Personal tools

From HEXONET Wiki

Jump to: navigation, search
(HTTP / HTTPS)
 
(75 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Sidebar}}
 
{{Sidebar}}
__NOTOC__
+
<div style="font-size: 160%;">Domain API</div>
These are the current methods of getting access to the HEXONET system:  
+
  
 +
These commands are required to manage your domain names e.g. Common domain commands, Host/Nameserver commands, Contact commands, Domain registry specific commands, Domain transfers, Branding, Control-Panel.
  
  
 +
__TOC__
  
= HTTP / HTTPS =
 
** The base url, in order to connect to our system is  https://api.ispapi.net/api/call.cgi
 
** The base url, in order to connect to our OT&E (Testbed System) is: https://api.ispapi.net/api/call.cgi?s_entity=1234
 
** [[HighPerformanceProxySetup|High Performance Proxy Setup (using Apache2's proxy module)]] 
 
  
= EPP =
+
==Domain API Documents: Downloads==
HEXONET now offers as probably the first provider worldwide access to our domain-robot via a real EPP 1.0 (Extensible Provisioning Protocol) strict to RFC 4930-4933. EPP is the recommended RFC 4930-4933 communication-protocol between Domain-Registars and the respective Registries.
+
{{Template:Pdf|epp_manual.pdf | EPP Manual}}<br>
With this EPP Implementation you now have access to more than 200 different TLDs through one single protocol. In the event that you hold different own accreditations then you now also have the possibility of managing your accreditation through RegistrarOC and connect to them through EPP.
+
{{Template:pdf|DOMAIN_API_Reference.pdf‎|Domain_API_Reference.pdf }}<br>
 +
{{Template:Pdf|SMTP_Gateway.pdf| SMTP-Gateway}}<br>
 +
{{Template:Pdf|SOAP_Gateway.pdf| SOAP-Gateway manual}}<br>
 +
{{Template:Pdf|XMLRPC_Gateway.pdf| XMLRPC-Gateway manual}}
  
{{Infobox|Please have a look at our {{Template:Pdf|epp_manual.pdf | EPP Manual}} with further information and EPP examples.}}
 
{{Infobox|Please have a look at our [[NetDri|EPP access using the Net::DRI perl library]]}}
 
  
We also provide an [http://www.hexonet.net/epp.php EPP Demonstrator] where you can easily execute EPP commands in our OT&E environment.
+
==Domain Commands: Online Documentation==
 +
*[[Domain commands|Domain commands]]
 +
*[[DNSSEC| DNSSEC API Command Extensions]]
  
<h2>EPP Gateway Information</h2>
 
  
<b>EPP production environment:</b><br>
+
== EPP ==
 +
HEXONET offers access to the domain-robot via a real EPP 1.0 (Extensible Provisioning Protocol) strict to RFC 4930-4933.  EPP is the recommended RFC 4930-4933 communication-protocol between Domain-Registars and the respective Registries. With this EPP Implementation you now have access to hundreds of TLDs through one single protocol. In the event that you hold own accreditations then you now also have the possibility of managing your own accreditations through RegistrarOC and connect to them through EPP.
  
Socket: epp.ispapi.net:700<br>
 
Login: Your Username<br>
 
Password: Your Password
 
  
<br>
+
Download: {{Template:Pdf|epp_manual.pdf | EPP Manual}} with further information and EPP examples.<br>
 +
See also: [[NetDri|EPP access using the Net::DRI perl library]]
 +
We also provide an [https://www.hexonet.net/software/epp-gateway-live-test EPP Demonstrator] where you can easily execute EPP commands in our OT&E environment.
  
<b>EPP Testbed / OTE:</b><br>
+
===EPP Gateway Information===
  
Socket: epp.ispapi.net:1700<br>
+
{| class="tablehexonet-striped"
Login: Your Username<br>
+
|-
Password: Your Password
+
! !! EPP production environment !! EPP Testbed / OTE
 +
|-
 +
| Socket: || epp.ispapi.net:700 || epp.ispapi.net:1700
 +
|-
 +
| Login: || Your Username || Your Username
 +
|-
 +
| Password: || Your Password || Your Password
 +
|}
  
  
Download: {{Template:Pdf|Epp_manual.pdf| EPP Manual}} 
 
  
 +
== HTTP / HTTPS ==
 +
'''Download:''' {{Template:pdf|DOMAIN_API_Reference.pdf‎|Domain_API_Reference.pdf }}
 +
*The base url is https://coreapi.1api.net/api/call.cgi
 +
*The base url for OT&E (Testbed System) is: https://api.ispapi.net/api/call.cgi?s_entity=1234
 +
*[[HighPerformanceProxySetup|High Performance Proxy Setup (using Apache2's proxy module)]]
  
= MAILROBOT =
+
Please note that your login credentials are different for the OT&E system, you can create an OT&E account [https://www.hexonet.net/signup-ote with this form].
** Download: {{Template:Pdf|SMTP_Gateway.pdf| SMTP-Gateway}} 
+
  
= SOAP/XMLRPC =
+
== MAILROBOT ==
** Download: {{Template:Pdf|SOAP_Gateway.pdf| SOAP-Gateway}}
+
All API commands can be executed via email templates sent to [mailto:call@mrobot.ispapi.net call@mrobot.ispapi.net]. call@mrobot.ispapi.net will also be the sender email address of HEXONET´s API call answers. To send emails to the API in OT&E mode, please use [mailto:call_ote@mrobot.ispapi.net call_ote@mrobot.ispapi.net] as recipient address. Please note that you first have to create an OT&E account before you start with testing. [http://hexonet.net/signup-ote  Get your OT&E account now!]
** Download: {{Template:Pdf|XMLRPC_Gateway.pdf| XMLRPC-Gateway}}
+
  
<headertabs/>
+
'''Download:''' {{Template:Pdf|SMTP_Gateway.pdf| SMTP-Gateway}}
<h2>Domain commands</h2>
+
Your login credentials and the API command which should be executed has to be submitted in the message body. Further you can submit some kind of transaction ID in the subject line. The HEXONET system will pass this subject to the response email.
  
These commands are neccessary to handle your domainnames e.g. Common domain commands, Host/Nameserver commands, Contact commands, Domain registry specific commands, Domain transfers, Branding, Control-Panel.
+
Example of an email to register a domain
  
 +
<pre>
 +
s_login = login.id
 +
s_pw = secret_password
 +
s_user = subuser.id
 +
 +
[COMMAND]
 +
command = AddDomain
 +
domain  = reseller.com
 +
ownercontact0 = (CONTACT)
 +
admincontact0 = (CONTACT)
 +
techcontact0 = (CONTACT)
 +
billingcontact0 = (CONTACT)
 +
...
 +
nameserver0 = ns1.yournameserver.com
 +
...
 +
nameserver12 = ns13.yournameserver.com
 +
EOF
 +
</pre>
  
*[[Domain commands|Domain commands]]
+
 
*[[DNSSEC| DNSSEC API Command Extensions]]
+
== SOAP/XMLRPC ==
 +
===SOAP-Gateway===
 +
This Realtime SOAP Gateway has been developed to provide an easy way to connect existing shopping
 +
cart and domain ordering systems to a user account of our system. The gateway consists of a SOAP server that accepts XML requests conforming to a defined syntax and converts them into API calls. All incoming SOAP requests are processed immediately and a XML response is generated and returned to the client.
 +
 
 +
'''Download:''' {{Template:Pdf|SOAP_Gateway.pdf| SOAP-Gateway manual}}<br>
 +
'''Download:''' {{Template:Pdf|XMLRPC_Gateway.pdf| XMLRPC-Gateway manual}}
 +
As we only offer two SOAP methods: ping for testing, xcall for XIRCA requests, we do not provide a public WSDL file. All XIRCA commands can be obtained in the respective manuals.
 +
 
 +
'''SOAP HTTP call parameters:'''
 +
 
 +
<pre>
 +
Server-/Proxy-URL: "http://soap-api.hexonet.net:8080"
 +
Namespace/URI: "urn:Api"
 +
available Methods: “echo” / “xcall”
 +
</pre>
 +
 
 +
'''SOAP HTTPS (SSL) call parameters:'''
 +
 
 +
<pre>
 +
Server-/Proxy-URL: "https://soap-api.hexonet.net:8082"
 +
Namespace/URI: "urn:Api"
 +
available Methods: “echo” / “xcall”
 +
</pre>
 +
 
 +
To access the OTE-system please simply specify the API parameter "s_entity=1234" to your request.
 +
 
 +
===XMLRPC-Gateway===
 +
 
 +
This Realtime XML-RPC Gateway has been developed to provide an easy way to connect existing shopping cart and domain ordering systems to a user account of our system. The gateway consists of a XML-RPC server that accepts XML requests conforming to a defined syntax and converts them into API calls. All incoming XML-RPC requests are processed immediately and a XML response is generated and returned to the client.
 +
 
 +
'''XML-RPC HTTP call parameters:'''
 +
 
 +
<pre>
 +
Server-/Proxy-URL: "http://xmlrpc-api.hexonet.net:8081"
 +
available Methods: “Api.echo” / “Api.xcall”
 +
</pre>
 +
 
 +
'''XML-RPC HTTPS (SSL) call parameters:'''
 +
 
 +
<pre>
 +
Server-/Proxy-URL: "https://xmlrpc-api.hexonet.net:8083"
 +
available Methods: “Api.echo” / “Api.xcall”
 +
 
 +
To access the OTE please simply specify the API parameter "s_entity=1234" to your request.
 +
</pre>

Latest revision as of 22:17, 16 June 2020

Domain API

These commands are required to manage your domain names e.g. Common domain commands, Host/Nameserver commands, Contact commands, Domain registry specific commands, Domain transfers, Branding, Control-Panel.


Contents


[edit] Domain API Documents: Downloads

EPP Manual
Domain_API_Reference.pdf
SMTP-Gateway
SOAP-Gateway manual
XMLRPC-Gateway manual


[edit] Domain Commands: Online Documentation


[edit] EPP

HEXONET offers access to the domain-robot via a real EPP 1.0 (Extensible Provisioning Protocol) strict to RFC 4930-4933. EPP is the recommended RFC 4930-4933 communication-protocol between Domain-Registars and the respective Registries. With this EPP Implementation you now have access to hundreds of TLDs through one single protocol. In the event that you hold own accreditations then you now also have the possibility of managing your own accreditations through RegistrarOC and connect to them through EPP.


Download: EPP Manual with further information and EPP examples.
See also: EPP access using the Net::DRI perl library We also provide an EPP Demonstrator where you can easily execute EPP commands in our OT&E environment.

[edit] EPP Gateway Information

EPP production environment EPP Testbed / OTE
Socket: epp.ispapi.net:700 epp.ispapi.net:1700
Login: Your Username Your Username
Password: Your Password Your Password


[edit] HTTP / HTTPS

Download: Domain_API_Reference.pdf

Please note that your login credentials are different for the OT&E system, you can create an OT&E account with this form.

[edit] MAILROBOT

All API commands can be executed via email templates sent to call@mrobot.ispapi.net. call@mrobot.ispapi.net will also be the sender email address of HEXONET´s API call answers. To send emails to the API in OT&E mode, please use call_ote@mrobot.ispapi.net as recipient address. Please note that you first have to create an OT&E account before you start with testing. Get your OT&E account now!

Download: SMTP-Gateway Your login credentials and the API command which should be executed has to be submitted in the message body. Further you can submit some kind of transaction ID in the subject line. The HEXONET system will pass this subject to the response email.

Example of an email to register a domain

 s_login = login.id
 s_pw = secret_password
 s_user = subuser.id
 
 [COMMAND]
 command = AddDomain
 domain  = reseller.com
 ownercontact0 = (CONTACT)
 admincontact0 = (CONTACT)
 techcontact0 = (CONTACT)
 billingcontact0 = (CONTACT)
 ...
 nameserver0 = ns1.yournameserver.com
 ...
 nameserver12 = ns13.yournameserver.com
 EOF


[edit] SOAP/XMLRPC

[edit] SOAP-Gateway

This Realtime SOAP Gateway has been developed to provide an easy way to connect existing shopping cart and domain ordering systems to a user account of our system. The gateway consists of a SOAP server that accepts XML requests conforming to a defined syntax and converts them into API calls. All incoming SOAP requests are processed immediately and a XML response is generated and returned to the client.

Download: SOAP-Gateway manual
Download: XMLRPC-Gateway manual As we only offer two SOAP methods: ping for testing, xcall for XIRCA requests, we do not provide a public WSDL file. All XIRCA commands can be obtained in the respective manuals.

SOAP HTTP call parameters:

Server-/Proxy-URL: "http://soap-api.hexonet.net:8080"
Namespace/URI: "urn:Api"
available Methods: “echo” / “xcall”

SOAP HTTPS (SSL) call parameters:

Server-/Proxy-URL: "https://soap-api.hexonet.net:8082"
Namespace/URI: "urn:Api"
available Methods: “echo” / “xcall”

To access the OTE-system please simply specify the API parameter "s_entity=1234" to your request.

[edit] XMLRPC-Gateway

This Realtime XML-RPC Gateway has been developed to provide an easy way to connect existing shopping cart and domain ordering systems to a user account of our system. The gateway consists of a XML-RPC server that accepts XML requests conforming to a defined syntax and converts them into API calls. All incoming XML-RPC requests are processed immediately and a XML response is generated and returned to the client.

XML-RPC HTTP call parameters:

Server-/Proxy-URL: "http://xmlrpc-api.hexonet.net:8081"
available Methods: “Api.echo” / “Api.xcall”

XML-RPC HTTPS (SSL) call parameters:

Server-/Proxy-URL: "https://xmlrpc-api.hexonet.net:8083"
available Methods: “Api.echo” / “Api.xcall”

To access the OTE please simply specify the API parameter "s_entity=1234" to your request.