net-opensrs/trunk/README
author mahlon
Fri, 05 Sep 2008 05:15:48 +0000
branchperl-modules
changeset 0 315eb12b224b
permissions -rw-r--r--
Reorganizing for Trac.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     1
Net-OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     2
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     3
DESCRIPTION
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     4
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     5
This is a wrapper interface to the DNS portions of the Tucows OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     6
HTTPS XML API.
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     7
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     8
    The client library distributed by OpenSRS can be difficult to
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
     9
    integrate into a custom environment, and their web interface becomes
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    10
    quickly tedious with heavy usage. This is a clean and relatively
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    11
    quick library to perform the most common API methods described in the
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    12
    OpenSRS API documentation.
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    13
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    14
    For example -- after initial setup, registering a domain can be 
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    15
    completed in one function call.  This makes Net::OpenSRS suitable
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    16
    for easy SRS integration into your own environment.
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    17
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    18
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    19
NOTES
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    20
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    21
    This module requires some setup in the OpenSRS reseller environment
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    22
    before it will work correctly.
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    23
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    24
    - You need to have an OpenSRS account, of course.  If you aren't an
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    25
      OpenSRS reseller, this module will be of limited use to you. :)
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    26
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    27
    - The machine(s) using this module need to have their public IP 
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    28
      addresses added to your 'Script API allow' list in the OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    29
      web interface.  (You only need to do this once.)
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    30
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    31
    - You need to generate your API keys - also in the the OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    32
      web interface.  (These keys are used for reseller authentication.)
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    33
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    34
    - For further information, please refer to the pod documentation.
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    35
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    36
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    37
INSTALLATION
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    38
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    39
To install this module, run the following commands:
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    40
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    41
    perl Makefile.PL
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    42
    make
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    43
    make test
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    44
    make install
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    45
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    46
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    47
SUPPORT AND DOCUMENTATION
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    48
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    49
After installing, you can find documentation for this module with the perldoc command.
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    50
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    51
    perldoc Net::OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    52
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    53
You can also look for information at:
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    54
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    55
    Search CPAN
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    56
        http://search.cpan.org/dist/Net-OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    57
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    58
    CPAN Request Tracker:
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    59
        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    60
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    61
    AnnoCPAN, annotated CPAN documentation:
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    62
        http://annocpan.org/dist/Net-OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    63
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    64
    CPAN Ratings:
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    65
        http://cpanratings.perl.org/d/Net-OpenSRS
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    66
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    67
COPYRIGHT AND LICENCE
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    68
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    69
Copyright (C) 2006 Mahlon E. Smith
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    70
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    71
This program is free software; you can redistribute it and/or modify it
315eb12b224b Reorganizing for Trac.
mahlon
parents:
diff changeset
    72
under the same terms as Perl itself.