- COPYRIGHT & LICENSE
WWW::LogicBoxes - Interact with LogicBoxes Reseller API
use strict; use warnings; use WWW::LogicBoxes; my $logic_boxes = WWW::LogicBoxes->new( username => 'resellerid', # You may specify a password OR an api_key password => 'Top S3cr3t!', api_key => 'reseller_api_key', response_type => 'json', sandbox => 0, ); my $domain_availabilities = $logic_boxes->check_domain_availability( slds => [qw( cpan drzigman brainstormincubator ], tlds => [qw( com net org )], suggestions => 0, );
WWW::LogicBoxes is a module for interacting with the LogicBoxes API. LogicBoxes 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::LogicBoxes which are used for making requests and "OBJECTS" in WWW::LogicBoxes which are used to represent data. Below these, documentation for the WWW::LogicBoxes module is included.
Commands are how operations are performed using the WWW::LogicBoxes API. They are seperated into related operations, for documentation on the specific command please see the linked pages.
Low level direct access to the LogicBoxes API. You rarely want to make use of this and instead want to use the abstracted commands outlined below.
Customer creation and retrieval. All domains belong to a customer.
Contacts are used in whois information and are required for domain registration.
- update_contact - OBSOLETE!
Used 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.
Retrieval of and management of registered domains.
Private nameservers are those that are based on the registered domain. For example, a domain of test-domain.com could have private nameservers ns1.test-domain.com and ns2.test-domain.com.
Rather than working with messy JSON objects, WWW::LogicBoxes 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 LogicBoxes. Documented further below.
WHOIS data contacts. Typically (with few exceptions) domains contains a Registrant, Admin, Technical, and Billing contact.
Extended contact used for .us domain registrations that contains the required Nexus Data.
Extended contact used for .ca domain registrations that contains the required CPR and CA Registrant Agreement Data.
The CA Registrant Agreement, contacts for .ca domains must accept it before being allowed to purchase .ca domains.
A LogicBoxes customer under the reseller account.
With the changes that became effective on Dec 1st, 2016 to ICANN rules for updating the registrant contact, this object was created to contain information related to an in progress IRTP Verification. See this object for additional information about the IRTP Changes.
A registered domain and all of it's related information.
A pending domain transfer and all of it's related information.
A response to a domain availability request. Contains the status of the domain and if it is available for registration.
Request to register a domain.
Request to transfer a domain.
Private Name Server record for a domain. Not all domains will have these.
In cases where a domain or contact requires additional information (such as .us domains requirning nexus data) factories exist so that the correct subclassed object is returned. As a consumer, you almost never want to call these directly, rather make use of the above "COMMANDS" and let this library worry about constructing the correct objects.
Constructs the correct subclassed contact.
The reseller id to use.
NOTE Password based authentication is now deprecated and is not allowed unless specifically requested from LogicBoxes for your reseller account. Instead, you should be using the api_key.
The API Key used for authentication. Either the password or the api_key MUST be specified, but NOT both. For backwards compatability apikey is an alias.
Defaults to "xml." Valid values include:
It should be noted that this setting is really only relevant when making Raw requests of the LogicBoxes API. When doing so this attribute defines the format of the responses.
my $logic_boxes = WWW::LogicBoxes->new( username => 'resellerid', # You may specify a password OR an api_key password => 'Top S3cr3t!', api_key => 'reseller_api_key', response_type => 'json', sandbox => 0, );
Creates a new instance of WWW::LogicBoxes that can be used for API Requests.
<drzigman AT cpan DOT org >
Special thanks to the following individuals who have offered commits, bug reports, and/or pull requests.
- Doug Schrag
- Brandon Husbands
- Slaven Rezic
COPYRIGHT & LICENSE
Copyright 2016 Robert Stone
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU Lesser General Public License as published by the Free Software Foundation; or any compatible license.
See http://dev.perl.org/licenses/ for more information.