API guides

OpenSRS API || Domain Service || Email Service || Publishing Service || Trust Service || OpenSRS Offers

OpenSRS API

OpenSRS API Integration Guide for XML

This guide is a good starting point when you are ready to integrate your site with OpenSRS via the API. It explains how to connect to the OpenSRS system and send API commands over HTTPS Post. For detailed information about each of the commands, as well as examples, please refer to the relevant API Reference guide.

OpenSRS API Specification for XML

Contains all of the available OpenSRS API commands as well as information about how to integrate with the OpenSRS system. This guide combines all of the information that is the service-specific command reference guides and the API Integration guide.

OpenSRS API Toolkits

The API Toolkits are available in PHP and Ruby to make integration easier. Find out more about the OpenSRS API Toolkits in the Developer area of the OpenSRS Forums.

Download PHP Toolkit (v3.0)
Download Ruby Toolkit (v1.2)

Domain Service

Domains API Commands Reference

Contains the API commands that allow you to provision and manage domain names. Explains all of the available parameters and values, and includes XML request and response examples for each command.

gTLD and ccTLD Reference Chart

We've put together a one-page quick reference chart listing the residency requirements, DNS requirements, redemption periods, and more for our gTLDs and ccTLDs.

Download

Sub-Resellers' OpenSRS API Specification for XML

Describes how to connect to the OpenSRS system and submit XML requests using XML over HTTPS Post. This guide is unbranded and can be distributed to Sub-Resellers.

Managed DNS API Specification

This document provides a description of how to use the TPP API for Managed DNS. We recommend that you familiarize yourself with TPP by referring to the TPP API Specification before reading this document.

Email Service

Account Provisioning Protocol (APP) Developer's Guide

The Account Provisioning Protocol provides a command-based, TCP/IP protocol that gives external clients a simplified command set to manage mailbox accounts. This guide provides the steps required to open an APP session and submit commands. It also provides a description of the available commands, prerequisites and requirements, as well as sample code, reference data, and parsing rules.

Publishing Service

Publishing Service API Command Reference

Contains the API commands that allow you to provision and manage the OpenSRS Publishing Service, including goMobi. Explains all of the available parameters and values, and includes XML request and response examples for each command.

Trust Service

Trust Service API Command Reference

Contains the API commands that allow you to provision and manage the OpenSRS Trust Service, including SSL certificates. Explains all of the available parameters and values, and includes XML request and response examples for each command.

OpenSRS Offers

Offers API Command Reference

Contains the API commands that allow you to generate and manage codes that represent Google AdWords credits. Includes XML request and response examples for each command.