OpenSRS Documentation
This page lists OpenSRS documentation for Resellers and their end users. OpenSRS also provides a non-branded documentation page where end user documentation is made available to your customers: helpdocumentation.com.
Domains
OpenSRS Quickstart Instructions
Provides an overview of the OpenSRS Quickstart interface, which allows you to start registering domains as soon as you have a OpenSRS account.
Reseller's Guide to Domain Name Registration and Management, Version 3.0
An overview of OpenSRS and the Reseller Web Interface (RWI), which is used for provisioning and managing domain names.
OpenSRS Domain Transfers Guide
An indepth look at the domain transfer process. This is a supplement to the Reseller's Guide to Domain Name Registration and Management.
OpenSRS API Specification
To make it easier to find the information that you need, we have split the "OpenSRS API Specification" guide into two versions: one for XML and one for Perl. As well as explaining the API commands that enable you to implement OpenSRS, the XML guide also includes all the information formerly found in the XML over HTTPS Post guide, and the Perl guide includes information from the Reseller Client Library guide.
OpenSRS API Specification for XML, Version 3.0
Describes how to connect to the OpenSRS system and submit XML requests using XML over HTTPS. Also contains all available OpenSRS API commands, including valid request and response parameters and values and XML examples of each command.
OpenSRS API Specification for Perl, Version 3.0
Describes how to install and use the Reseller Client Library. Also contains all available OpenSRS API commands, including valid request and response parameters and values and Perl examples of each command.
Parked Pages and Expired Domains Programs
On November 17, 2007, OpenSRS brought our domain parking program out of beta and made it official. At the same time, we split what was a single program into two similar but distinct services: Parked Pages Program and Expired Domains Program. Click here to read more about these programs.
Tucows Provisioning Protocol (TPP) API Specification
OpenSRS TPP API Specification, Version 2.9.4
An API specification that outlines the generic principles and command sets of the TPP API.
Exceptions to Real-Time Processing
New orders and service items are processed in real-time; however, in rare instances, an item may not process immediately. This document describes the notification mechanism that allows Service Providers to check the status of their transactions that were processed asynchronously.
OpenSRS Email Service
Mail Administration Center (MAC) User's Guide
The Mail Administration Center is the web-based interface for administrating email accounts and includes access to, and configuraton of, branding and reporting settings. This guide illustrates each screen within the MAC and provides step-by-step instructions for executing the related tasks such as: logging in and out of the MAC, adding and modifying domains, accounts (mailboxes), and workgroups, branding the webmail interface, and setting up reports.
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.
DNS Configuration Guide
Domain Name System (DNS) is the Internet protocol and distributed database that maps domain names and hostnames (e.g., www.name.com) to the appropriate IP addresses (e.g., 216.25.52.75). This guide explains the types of DNS records and provides the values that these records need to be modified to in order to use the OpenSRS Email Service.
Email Client Configuration Guide — unbranded
This guide describes the principles behind configuring email clients as well as providing some client-specific walk-throughs. It is intended to help the novice end-user set up their email if they choose to use a client instead of, or in conjunction with the webmail interface.
SSL Digital Certificates
SSL Certificates API Specification, Version 2.9.6
A description of how to use the TPP API for SSL Certificates. We recommended that you familiarize yourself with TPP by referring to TPP API Specification before reading this document.
SSL Certificates RWI 2 User Guide, Version 2.9.6
This guide provides information on using the Reseller Web Interface 2 to provision and manage SSL Certificates.
Managed DNS
Managed DNS API Specification, Version 2.8.8
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.
Managed DNS RWI 2 User Guide, Version 2.9.6
This guide provides information on using the Reseller Web Interface 2 to provision and manage the Managed DNS service.
HRS
OpenHRS Operating Manual
A guide to the Administrator Web Interface (AWI), which, as an acredited Registrar, you can use to process your registrations and maintain your domains under management.
Web Site Builder
Website Builder API Specification, Version 2.9.3
This document describes how to use the TPP API for provisioning the Website Builder service. We recommend that you familiarize yourself with TPP by referring to the TPP API Specification before reading this document.
Website Builder RWI 2 User Guide, Version 2.9.6
This document describes how to use the Reseller Web Interface 2 to purchase and manage the Website Builder service.
Website Builder User Manual
This document describes how to use the Website Builder tool to create and maintain a website. It is available in PDF format in the following languages.
Blogware
Blogware Reseller Control Panel Guide
A guide to the Reseller Control Panel, which you use to manage your customers' weblogs.
Blogware Reseller Provisioning API, Version 1.3
Includes descriptions and examples of the API commands available for provisioning and managing your customers' blogs.
Blogware Publisher Control Panel Guide
A comprehensive guide on how to use the Publisher Control Panel to maintain and manage a blog.
Blogware Publisher Guide: Blogware in a Hurry
A quick guide to the basics of Blogware, designed to help you get up and blogging in no time.
Blogware Publisher Guide: Advanced Templates
A publisher's guide for modifying templates.
Guía del editor de Blogware
Blogware Publisher Control Panel Guide
Spanish version Guía completa de uso de Blogware.
Guide de l'auteur de Blogiciel
Blogware Publisher Control Panel Guide, French version
Mode d'emploi des commandes de Blogiciel.
Mode d'emploi Blogiciel pour l'auteur: Blogger, en bref
Blogware Publisher Guide: Blogware in a Hurry, French version
Mode d'emploi rapide des commandes de base de Blogiciel. Conçu afin de vous faciliter l'utilisation du logiciel.