Personal tools

From HEXONET Wiki

Jump to: navigation, search
Line 37: Line 37:
  
 
== HTTP / HTTPS ==
 
== HTTP / HTTPS ==
{{Infobox|Download: {{Template:pdf|DOMAIN_API_Reference.pdf‎|Domain_API_Reference.pdf }}}}
+
'''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 is https://api.ispapi.net/api/call.cgi
 
*The base url for OT&E (Testbed System) is: https://api.ispapi.net/api/call.cgi?s_entity=1234
 
*The base url for OT&E (Testbed System) is: https://api.ispapi.net/api/call.cgi?s_entity=1234
Line 46: Line 46:
 
All API commands can be executed via email templates sent to [mailto:[email protected] [email protected]]. [email protected] 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:[email protected] [email protected]] 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!]
 
All API commands can be executed via email templates sent to [mailto:[email protected] [email protected]]. [email protected] 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:[email protected] [email protected]] 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!]
  
{{Infobox|Download: {{Template:Pdf|SMTP_Gateway.pdf| SMTP-Gateway}}}}
+
'''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.
 
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.
  
Line 76: Line 76:
 
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.
 
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.
  
{{Infobox|Download: {{Template:Pdf|SOAP_Gateway.pdf| SOAP-Gateway manual}}<br>
+
'''Download:''' {{Template:Pdf|SOAP_Gateway.pdf| SOAP-Gateway manual}}<br>
Download: {{Template:Pdf|XMLRPC_Gateway.pdf| XMLRPC-Gateway manual}}}}
+
'''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.
 
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.
  

Revision as of 17:36, 26 March 2014

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


Domain Commands


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.





We also provide an EPP Demonstrator where you can easily execute EPP commands in our OT&E environment.

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


HTTP / HTTPS

Download: Domain_API_Reference.pdf


MAILROBOT

All API commands can be executed via email templates sent to [email protected]. [email protected] 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 [email protected] 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


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: 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(s)://93.190.235.176:8080" (use Port 8082 for SSL access)
Namespace/URI: "urn:Api"
available Methods: “echo” / “xcall”


SOAP HTTPS (SSL) call parameters:

Server-/Proxy-URL: "http://93.190.235.176: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.


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:
IP: 93.190.235.176
Port: 8081
Server-/Proxy-URL: "http://93.190.235.176:8081"
available Methods: “Api.echo” / “Api.xcall”

XML-RPC HTTPS (SSL) call parameters:
IP: 93.190.235.176
Port: 8083
Server-/Proxy-URL: "http://93.190.235.176:8083"
available Methods: “Api.echo” / “Api.xcall”

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