.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "WWW::CNic 3pm"
.TH WWW::CNic 3pm "2015-06-22" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
WWW::CNic \- a web\-based API for the CentralNic domain registry system.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use WWW::CNic;
\&
\&        my @suffixlist = qw(uk.com us.com de.com eu.com);
\&
\&        my $query = WWW::CNic\->new(command => \*(Aqsearch\*(Aq, \*(Aqdomain\*(Aq => \*(Aqexample\*(Aq);
\&
\&        $query\->set(suffixlist => \e@suffixlist);
\&
\&        my $response = $query\->execute;
\&
\&        if ($response\->is_error) {
\&                printf("Error: %s\en", $response\->error);
\&
\&        } else {
\&                foreach my $suffix(@suffixlist) {
\&                        if ($response\->is_registered) {
\&                                printf("Domain %s.%s is registered to %s\en", $domain, $suffix, $response\->registrant($suffix));
\&
\&                        } else {
\&                                printf("Domain %s.%s is available for registration\en", $domain, $suffix);
\&
\&                        }
\&                }
\&        }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`WWW::CNic\*(C'\fR provides a powerful object-oriented Perl interface to the CentralNic Toolkit system.
.PP
The design of \f(CW\*(C`WWW::CNic\*(C'\fR is inspired greatly by \f(CW\*(C`LWP\*(C'\fR, which is a prerequisite. Essentially, making a transaction requires building a \fIrequest\fR object, which is then executed and returns a \fIresponse\fR object. While each transaction type (search, registration, modification...) requires a different set of data to be sent by the client, all the response objects have common properties, inherited from the \f(CW\*(C`WWW::CNic::Response\*(C'\fR base class, with just a few extra methods for accessing specific information.
.SH "INSTALLATION"
.IX Header "INSTALLATION"
Installing \f(CW\*(C`WWW::CNic\*(C'\fR is as simple as:
.PP
.Vb 7
\&        cd /usr/src
\&        wget http://toolkit.centralnic.com/dist/WWW\-CNic\-x.xx.tar.gz
\&        tar zxvf WWW\-CNic\-x.xx.tar.gz
\&        cd WWW\-CNic\-x.xx
\&        perl Makefile.PL
\&        make
\&        make install
.Ve
.SH "PREREQUISITES"
.IX Header "PREREQUISITES"
.IP "1." 4
\&\f(CW\*(C`LWP\*(C'\fR \- the \s-1WWW\s0 Library for Perl. This in turn requires \f(CW\*(C`libnet\*(C'\fR, \f(CW\*(C`URI\*(C'\fR and \f(CW\*(C`HTML::Parser\*(C'\fR.
.IP "2." 4
An \s-1SSL\s0 toolkit (\f(CW\*(C`Crypt::SSLeay\*(C'\fR, \f(CW\*(C`IO::Socket::SSL\*(C'\fR) for doing \s-1HTTPS\s0 transactions.
.IP "3." 4
\&\f(CW\*(C`Digest::MD5\*(C'\fR is needed for hashing passwords.
.SH "USAGE"
.IX Header "USAGE"
Consult WWW::CNic::Cookbook for detailed information on using WWW::CNic.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.Vb 1
\&        my $query = WWW::CNic\->new( [OPTIONS] );
.Ve
.PP
The constructor for this class accepts the following options:
.IP "1." 4
\&\f(CW\*(C`username\*(C'\fR \- only needed for doing domain registrations and modifications. This is the User \s-1ID\s0 of your Registrar Handle.
.IP "2." 4
\&\f(CW\*(C`password\*(C'\fR \- the password for your Registrar Handle.
.IP "3." 4
\&\f(CW\*(C`command\*(C'\fR \- required for every transaction. This is a scalar containing the command name. The list of allowed commands is always growing, you should consult the Toolkit website for a complete list.
.IP "4." 4
\&\f(CW\*(C`domain\*(C'\fR \- only needed for domain registrations, modifications and other commands that act upon domains.
.IP "5." 4
\&\f(CW\*(C`host\*(C'\fR \- allows you to use to a non-standard host. This is mainly useful for client debugging purposes.
.IP "6." 4
\&\f(CW\*(C`test\*(C'\fR \- when set to \f(CW1\fR, this causes any domain registration and modification transactions to use the test database. Again, this is useful for testing and debugging.
.IP "7." 4
\&\f(CW\*(C`keep_alive\*(C'\fR \- by default, WWW::CNic will use \f(CW\*(C`LWP::ConnCache\*(C'\fR to cache server connections. Setting \f(CW\*(C`keep_alive\*(C'\fR to \f(CW0\fR or \f(CW\*(C`undef\*(C'\fR will turn this off.
.SH "METHODS"
.IX Header "METHODS"
.Vb 1
\&        $query\->set( NAME => VALUE );
.Ve
.PP
This method allows you to set any number of parameters prior to executing the query. The specifics of what parameters are required for what type of transaction is explained in WWW::CNic::Cookbook.
.PP
.Vb 1
\&        my $response = $query\->execute();
.Ve
.PP
This method makes the transaction and returns an instance of a \f(CW\*(C`WWW::CNic::Response\*(C'\fR child class.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is (c) 2011 CentralNic Ltd. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
http://toolkit.centralnic.com/
.IP "\(bu" 4
WWW::CNic::Cookbook
.IP "\(bu" 4
WWW::CNic::Simple