Editing Domain API

{{Sidebar}}
<div style="font-size: 160%;">Domain API</div>

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__


==Domain API Documents: Downloads==
{{Template:Pdf|epp_manual.pdf | EPP Manual}}<br>
{{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}}

==Domain Commands: Online Documentation==
*[[Domain commands|Domain commands]]
*[[DNSSEC| DNSSEC API Command Extensions]]

==New LIVE environment (as of June 21, 2022)==
On June 21, 2022 we are migrating to a new data center, to increase efficiency and security.

===Major Changes===
* We are updating the IP addresses of our APIs. Endpoints and ports will remain the same
* We support only secure connections, please ensure you are using HTTPS instead of HTTP
* We are removing weak TLS v1.2 ciphers
* TLS v1.3 will be supported as of June 21, 2022

===Endpoints, Ports and IP Addresses===
<table width='100%' class="tablehexonet-striped">
<tr><td><b>API</b></td><td><b>Endpoint</b></td><td><b>Old IP</b></td><td><b>New IP</b></td></tr>
<tr><td>LIVE HTTPS server</td><td>''preferred:'' api.ispapi.net:443<br/><br/>''former endpoints, still available:''<br/>api.1api.net:443<br/>coreapi.1api.net:443</td><td>api.ispapi.net (93.190.235.100)<br/><br/><br/>api.1api.net (93.190.235.100)<br/>coreapi.1api.net (93.190.235.100)</td><td>api.ispapi.net (109.234.111.115)<br/><br/><br/>api.1api.net (109.234.111.115)<br/>coreapi.1api.net (109.234.111.115)</td></tr>
<tr><td>LIVE EPP server</td><td>epp.ispapi.net:700</td><td>epp.ispapi.net (93.190.235.100)</td><td>epp.ispapi.net (109.234.111.116)</td></tr>
<tr><td>LIVE SOAP server</td><td>soap-api.hexonet.net:8082</td><td>soap-api.hexonet.net (93.190.235.176)</td><td>soap-api.hexonet.net (109.234.111.115)</td></tr>
<tr><td>LIVE XML-RPC server</td><td>xmlrpc-api.hexonet.net:8083</td><td>xmlrpc-api.hexonet.net (93.190.235.176)</td><td>xmlrpc-api.hexonet.net (109.234.111.115)</td></tr>
<tr><td>LIVE XRRP-Server</td><td>''new &amp; prefered:'' xrrp.ispapi.net:649<br/><br/>''former endpoints, still available:''<br/>api.1api.net:649<br/>coreapi.1api.net:649<br/>api.ispapi.net:649</td><td>N/A<br/><br/><br/>api.ispapi.net (93.190.235.100)<br/>api.1api.net (93.190.235.100)<br/>coreapi.1api.net (93.190.235.100)</td><td>xrrp.ispapi.net (109.234.111.115)<br/><br/><br/>api.ispapi.net (109.234.111.115)<br/>api.1api.net (109.234.111.115)<br/>coreapi.1api.net (109.234.111.115)</td></tr>
<tr><td>LIVE Email Gateway</td><td>mrobot.ispapi.net:25</td><td>mrobot.ispapi.net (93.190.235.175)</td><td>mrobot.ispapi.net 
(109.234.111.123)</td></tr>
</table>

===Secure Connections===

Unencrypted access is not supported any more (formerly ports 80, 8080 and 8081). Please ensure e.g. that you are using HTTPS instead of HTTP.

===Changed TLS v1.2 Support===

Weak TLS v1.2 ciphers will be removed and only the following TLS v1.2 ciphers will be supported:
* TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
* TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
* TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
* TLS_DHE_RSA_WITH_AES_128_GCM_SHA256

Please note, you can test if your system uses the correct ciphers, by connecting to our OT&E environment, as this has already been moved to the new data center.

===New TLS v1.3 Support===

TLS v1.3 will be supported as of June 21, 2022 with the following ciphers:
* TLS_AES_256_GCM_SHA384
* TLS_CHACHA20_POLY1305_SHA256
* TLS_AES_128_GCM_SHA256

===AXFR zone transfers===
The source IP address from which AXFR transfers for Secondary zones get requested will change to '''109.234.111.161'''. Please make sure that this IP address is whitelisted for AXFR transfers in the respective Primary nameserver

== New OTE environment (as of March 21, 2022) ==
As of March 21, 2022 you have to use the following new endpoints and ports in order to access the OTE environment via APIs:
<table width='100%' class="tablehexonet-striped">
<tr><td><b>OTE API server</b></td><td><b>old endpoint(s) and port</b></td><td><b>new endpoint and port</b></td></tr>
<tr><td>OTE HTTP(S) server</td><td>api.1api.net:80 + 443<br/>coreapi.1api.net:80 + 443<br/>api.ispapi.net:80 + 443</td><td>api-ote.ispapi.net:443</td></tr>
<tr><td>OTE EPP server</td><td>epp.ispapi.net:1700</td><td>epp-ote.ispapi.net:700</td></tr>
<tr><td>SOAP server</td><td>soap-api.hexonet.net:8080 + 8082</td><td>soap-api-ote.hexonet.net:8082</td></tr>
<tr><td>XML-RPC server</td><td>xmlrpc-api.hexonet.net:8081 + 8083</td><td>xmlrpc-api-ote.hexonet.net:8083</td></tr>
<tr><td>XRRP-Server</td><td>api.1api.net:649<br/>coreapi.1api.net:649<br/>api.ispapi.net:649</td><td>xrrp-ote.ispapi.net:649</td></tr>
<tr><td>Email Gateway</td><td>call_ote@mrobot.ispapi.net</td><td>call@mrobot-ote.ispapi.net</td></tr>
</table>

Unencrypted access is not supported any more (formerly ports 80, 8080 and 8081).

The new endpoints will support following TLS ciphers:

* TLS 1.2
** TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
** TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
** TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
** TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
** TLS_DHE_RSA_WITH_AES_128_GCM_SHA256

* TLS 1.3
** TLS_AES_256_GCM_SHA384
** TLS_CHACHA20_POLY1305_SHA256
** TLS_AES_128_GCM_SHA256

=== Supported TLDs in the new OTE environment ===

The following TLDs are supported in the new OTE environment: 
.asia, .at, .be, .biz, .ca, .ch, .club, .com, .co.za, .cz, .de, .es, .eu, .fr, .guru, .info, .it, .la, .net, .nl, .nz, .org, .pe, .ph, .photo, .pl, .se, .swiss, .uk, .xyz

== 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: {{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.

===EPP Gateway Information===

{| class="tablehexonet-striped"
|-
! !! EPP production environment !! EPP Testbed / OTE
|-
| Socket: || epp.ispapi.net:700 || epp-ote.ispapi.net:700
|-
| Login: || Your Username || Your Username
|-
| Password: || Your Password || Your Password
|}



== HTTP / HTTPS ==
'''Download:''' {{Template:pdf|DOMAIN_API_Reference.pdfâ|Domain_API_Reference.pdf }}
*The base url is https://api.ispapi.net/api/call.cgi
*The base url for OT&E (Testbed System) is: https://api-ote.ispapi.net/api/call.cgi?s_entity=1234
*[[HighPerformanceProxySetup|High Performance Proxy Setup (using Apache2's proxy module)]]

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].

== MAILROBOT ==
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@mrobot-ote.ispapi.net call@mrobot-ote.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|SMTP_Gateway.pdf| 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

<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>


== 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 HTTPS (SSL) call parameters:'''

<pre>
Server-/Proxy-URL LIVE system: "https://soap-api.hexonet.net:8082"
Server-/Proxy-URL OT&E system: "https://soap-api-ote.hexonet.net:8082"
Namespace/URI: "urn:Api"
available Methods: âechoâ / âxcallâ
</pre>


===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 HTTPS (SSL) call parameters:'''

<pre>
Server-/Proxy-URL LIVE system: "https://xmlrpc-api.hexonet.net:8083"
Server-/Proxy-URL OT&E system: "https://xmlrpc-api-ote.hexonet.net:8083"

available Methods: âApi.echoâ / âApi.xcallâ
</pre>