OpenSRS API Integration for XML

More documents

Recommendations

Info

Table of Contents Introduction...............................................................................3 Purpose..................................................................................3 Audience................................................................................4 Using HTTPS Post to Access OpenSRS............................................4 Authenticating with the OpenSRS API.........................................4 Testing environment................................................................4 Connection Information............................................................5 MD5 authentication...............................................................5 Construction of the POST Data...................................................5 Response Messages.................................................................6 Troubleshooting HTTPS Post......................................................7 OpenSRS protocol.......................................................................8 Protocol message structure.......................................................9 OPS message examples..........................................................13 Semantic validity and API implementation.................................15 Writing Your Own Client.............................................................17 XML client protocol fundamentals.............................................17 MD5 Examples.......................................................................18 Coding Examples...................................................................20 Perl example......................................................................20 PHP example......................................................................24 VB6 example......................................................................26 VB .NET example................................................................31 Java example.....................................................................32 Data exchange......................................................................39 Authentication handshake.......................................................39 Encryption............................................................................42 Reseller Agent Return Codes.......................................................43
Introduction Welcome to the OpenSRS API Integration guide for the registration and management of domain names and domain related services. Using this document, you can provide OpenSRS functionality to your customers by integrating API commands into your website that can send XML requests to OpenSRS over HTTPS Post. You can also use API commands to run queries or automate tasks you would otherwise perform manually using the OpenSRS Reseller Web Interface (RWI). You can leverage the API to allow registrants to view and update their contact details, nameservers, transfer auth codes, domain locking, whois privacy, and username and password settings. Additionally, the API can be used to perform domain availability lookups, provide domain search suggestions and aftermarket domain lookups, as well as process registrations, transfers, and renewals. Registrants are set up with a profile in which multiple domains can be stored. A profile is defined by a username, password, and one of the domains in the profile. When requesting information or updating domain information, an authorization cookie needs to be requested first using a domain in the profile and the username and password for the profile. The cookie is then submitted with the request to look up or modify a domain's details, as well as when changing name servers assigned to a registered domain. Purpose The method of sending commands to OpenSRS using HTTPS Post supports communication between a client process and the OpenSRS system. This document describes how to formulate the XML commands and how to use HTTPS Post to send the XML commands to OpenSRS. Using this document as a reference, you can use any programming language to write an implementation that supports this communication. If you are writing your own implementation, please refer to the "Design Considerations" section. The process for executing commands consists of formulating the command in XML and sending it to OpenSRS via HTTPS Post. This guide outlines the basic method for creating the XML in a format usable by OpenSRS and includes some language-specific methods. The protocol assumes that the client process that is requesting an action waits for a result from the server process in response to the requested action. The protocol does not support session tracking.
Page 1: OpenSRS API Integration for XML
Page 5 and 6: Connection Information Live product
Page 7 and 8: Troubleshooting HTTPS Post Note: Th
Page 9 and 10: Protocol message structure DTD An O
Page 11 and 12: Example ? ? The data struct
Page 13 and 14: OPS message examples Example 1 This
Page 15 and 16: Tom Jones Semantic validity an
Page 17 and 18: Example 2 The following two data bl
Page 19 and 20: VB6 Using the “di_MD5DLL.dll” f
Page 21 and 22: ( %in, $cgi) = (); # Required Perl
Page 23 and 24: # Perl Hash Output Of Response prin
Page 25 and 26: LOOKUP XCP example.com '; $s
Page 27 and 28: On Error GoTo err_Main pFileRequest
Page 29 and 30: '' Else ' let's wait for a while ''
Page 31 and 32: ' ' ' MyDomainToLookup.com ' '
Page 33 and 34: public class SslClient { private St
Page 35 and 36: } catch (Exception ex) { throw new
Page 37 and 38: } public void setHost(String host)
Page 39 and 40: catch (TaskExecuteException e) { }
Page 41 and 42: Process Description The only differ
Page 43 and 44: Private key DES only supports keys
Page 45 and 46: Code 415 Response text / Explanatio
Page 47 and 48: Code Response text / Explanation No

OpenSRS API Integration for XML

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?