WWW::eNom - Interact with eNom, Inc.'s reseller API
use WWW::eNom; my $eNom = WWW::eNom->new( username => "resellid", password => "resellpw", response_type => "xml_simple", # Optional, defaults to xml_simple test => 1 # Optional, defaults to 0 ( production ) ); # Check If Domains Are Available my $domain_availabilities = $eNom->check_domain_availability( slds => [qw( cpan drzigman brainstormincubator )], tlds => [qw( com net org )], suggestions => 0, );
WWW::eNom is a module for interacting with the eNom API. eNom is a domain registrar and the API performs operations such as checking domain availability, purchasing domains, and managing them.
This module is broken down into two primary components (documented below). These are "COMMANDS" in WWW::eNom which are used for making requests and "OBJECTS" in WWW::eNom which are used to represent data. Below these, documentation for the WWW::eNom module is included.
Commands are how operations are performed using the WWW:eNom API. They are separated into related operations, for documentation on the specific command please see the linked pages.
Love level direct access to the eNom API. You rarely want to make use of this and instead want to use the abstracted commands outline below.
Contact retrieval.
Use for checking to see if a domain is available for registration as well as getting suggestions of other potentially relevant domains.
New Domain Registration.
New Domain Transfers.
Domain retrieval and management.
Addon products that can be sold along with domains.
Management of Private Name Servers.
Rather than working with messy XML objects or HashRefs, WWW::eNom implements a series of Moose objects for making requests and processing responses. All commands that take an object have coercion so a HashRef can be used in it's place.
Primary interface to eNom. Documented further below.
WHOIS data contacts. Typically (with few exceptions) domains contain a Registrant, Admin, Technical, and Billing contact.
A registered domain and all of the domain's related information.
An in progress domain transfer and all of it's related information.
Request to register a domain.
Request to transfer a domain.
Private nameservers.
eNom Reseller ID
eNom Reseller Password
Boolean that defaults to false. If true, requests will be sent to the eNom test endpoint rather than production.
Defaults to 'xml_simple'. Valid values include:
It should be noted that this setting is really only relevant when making Raw requests of the eNom API. When doing so this attribute defines the format of the responses.
my $eNom = WWW::eNom->new( username => "resellid", password => "resellpw", response_type => "xml_simple", # Optional, defaults to xml_simple test => 1 # Optional, defaults to 0 ( production ) );
Constructs a new object for interacting with the eNom API. If the "test" parameter is given, then the API calls will be made to the test server instead of the live one.
As of v0.3.1, an optional "response_type" parameter is supported. For the sake of backward compatibility, the default is "xml_simple"; see below for an explanation of this response type. Use of any other valid option will lead to the return of string responses straight from the eNom API. These options are:
As of v1.0.0, this module has been renamed to WWW::eNom. Net::eNom is now a thin wrapper to preserve backward compatibility.
Robert Stone, <drzigman AT cpan DOT org>
<drzigman AT cpan DOT org>
Original version by Simon Cozens <simon at simon-cozens.org>. Then maintained and expanded by Richard Simões, <rsimoes AT cpan DOT org>.
<simon at simon-cozens.org>
<rsimoes AT cpan DOT org>
Copyright © 2016 Robert Stone. This module is released under the terms of the MIT License and may be modified and/or redistributed under the same or any compatible license.
To install WWW::eNom, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WWW::eNom
CPAN shell
perl -MCPAN -e shell install WWW::eNom
For more information on module installation, please visit the detailed CPAN module installation guide.