README

This provision category contains common functions used in domain name provisioning flows with various registries and registrar/reseller platforms.

Installation
Usage
- Quick-start
Supported Providers
Functions
Changelog
Contributing
Credits
License
Upmind

Installation

composer require upmind/provision-provider-domain-names

Usage

This library makes use of upmind/provision-provider-base primitives which we suggest you familiarize yourself with by reading the usage section in the README.

Quick-start

The easiest way to see this provision category in action and to develop/test changes is to install it in upmind/provision-workbench.

Alternatively you can start using it for your business immediately with Upmind.com - the ultimate web hosting billing and management solution.

If you wish to develop a new Provider, please refer to the WORKFLOW guide.

Supported Providers

The following providers are currently implemented:

Functions

Function	Parameters	Return Data	Description
poll()	PollParams	PollResult	Poll for the latest relevant domain event notifications e.g., successful transfer-in, domain deletion etc
domainAvailabilityCheck()	DacParams	DacResult	Check the availability of a domain SLD across one or more TLDs
register()	RegisterDomainParams	DomainResult	Register a new domain name
transfer()	TransferParams	DomainResult	Initiate and/or check a domain name transfer, returning successfully if transfer is complete
renew()	RenewParams	DomainResult	Renew a domain name for a given number of years
getInfo()	DomainInfoParams	DomainResult	Get information about a domain name including status, expiry date, nameservers, contacts etc
updateRegistrantContact()	UpdateDomainContactParams	ContactResult	Update the registrant contact details of a domain name
updateContact()	UpdateContactParams	ContactResult	Update the contact details of a domain name for every contact type, registrant/techinical/admin/billing
updateNameservers()	UpdateNameserversParams	NameserversResult	Update a domain's nameservers
setLock()	LockParams	DomainResult	Lock or unlock a domain name for transfers and changes
setAutoRenew()	AutoRenewParams	DomainResult	Toggle registry auto-renewal for a domain name
getEppCode()	EppParams	EppCodeResult	Get the EPP/Auth code of a domain name
updateIpsTag()	IpsTagParams	ResultData	Release a domain name to a new IPS tag (UK-only)
getVerificationStatus()	VerificationStatusParams	VerificationStatusResult	Get the verification status of a domain name
resendVerificationEmail()	ResendVerificationParams	ResendVerificationResult	Resend the verification email for a domain name
setGlueRecord()	SetGlueRecordParams	GlueRecordsResult	Set a glue record for a domain name
removeGlueRecord()	RemoveGlueRecordParams	GlueRecordsResult	Remove a glue record from a domain name
getStatus()	DomainInfoParams	StatusResult	Get the current normalized status of a domain name along with the expiry date and raw provider statuses

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

GNU General Public License version 3 (GPLv3). Please see License File for more information.

Upmind

Sell, manage and support web hosting, domain names, ssl certificates, website builders and more with Upmind.com.

upmind / provision-provider-domain-names

Maintainers

Package info

Statistics

Security