Tucows Documentation

This page lists Tucows' documentation for Resellers and their end users. Documentation for Tucows services not listed here can be found on the other services documentation page.

Tucows also provides a non-branded documentation page where end user documentation is made available to your customers: helpdocumentation.com.

Tucows Email Service

Tucows Email Service was implemented on July 2007. If your service predates this, and you have not been migrated to the new system, please see the Email and Email Defense section below.

The Tucows Email Service administration login can be found at https://admin.hostedemail.com

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., 234.566.909). 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 Tucows 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.

Mail Administration Center (MAC) User's Guide

The Mail Administration Center is Tucow's 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.

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.

Domains

Now Available!Parked Pages and Expired Domains Programs

On November 17, 2007, Tucows 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.

OpenSRS Quickstart Instructions

Provides an overview of the OpenSRS Quickstart interface, which allows you to start registering domains as soon as you have a Tucows 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.

Domain Name Auction Reseller Guide

Important!Before implementing the Domain Name Auction tool, please contact your Account Manager.

This guide is for Resellers and includes instructions on branding your instance of the Domain Name Auction tool, monitoring auctions and auction financials within your profile, and managing your users' auction accounts.

Domain Name Auction User Guide

This is the End User guide for the Domain Name Auction tool. It includes instructions on how to search for expiring domain names, bid on expiring domain names, and manage your bids.

A zip archive of the HTML files in the online help is provided for Service Providers who would like to customize the help and make it available from their website.

Legal Type and Registrant Name Rules for CIRA

Resellers of .CA domains should review this document to understand CIRA's Registration rules.

» Back to top

Client Code Suite (CCS)

CCS Installation and Setup Guide

The OpenSRS Client Code Suite (CCS) is a cross-platform and extendible package of interfaces that allows your customers to buy and manage the services you provide.

Platypus/CCS Integration Guide

Platypus is a billing and subscriber management system, designed to meet the back office needs of internet service providers.

This document describes the process of setting up Platypus and CCS to work together so that you can provision and bill for Domains and Blogware using one system.

Customizing CCS Using the ACF Configuration Tool

This document explains how to customize CCS templates and functionality. Functionality customizations include adding new functionality, changing the order of events, and replacing functionality.

Installing CCS on Fedora Core 5

This document provides the steps for installing CCS on a new installation of Fedora Core 5.

» Back to top

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.

» Back to top

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

» Back to top

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.

» Back to top

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.

» Back to top

Download Adobe Acrobat reader, required to view the .pdf files.

Problems? Contact reseller-support@opensrs.org (1-800-371-6992)