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