Fred Registrar API Documentation

Introduction

This document provides an overview of how to use the Free Registry for ENUM and Domains (FRED) API for managing domain names. The API allows users to perform various domain-related operations such as registering, transferring, renewing, and managing DNS and contact information.

Prerequisites

Before using the FRED API, ensure you have the following:

FRED API Credentials: Username and password for authentication.
EPP Class Library: A PHP library for handling EPP (Extensible Provisioning Protocol) requests.
Configuration File: A config.php file containing your API credentials and settings.

Configuration

The configuration function fred_getConfigArray returns an array of configuration settings required for connecting to the FRED API.

function fred_getConfigArray() {
$configarray = array(
“Username” => array(“Type” => “text”, “Size” => “20”, “Description” => “Enter your username here”),
“Password” => array(“Type” => “password”, “Size” => “20”, “Description” => “Enter your password here”),
“TestMode” => array(“Type” => “yesno”),
);
return $configarray;
}

Nameserver Management

Get Nameservers

The fred_GetNameservers function retrieves the nameservers for a given domain.

Save Nameservers

The fred_SaveNameservers function updates the nameservers for a given domain.

Domain Lock Management

Get Registrar Lock

The fred_GetRegistrarLock function retrieves the lock status of a domain.

Save Registrar Lock

The fred_SaveRegistrarLock function updates the lock status of a domain.

Email Forwarding ManagementGet Email Forwarding

The fred_GetEmailForwarding function retrieves email forwarding settings.

function fred_GetEmailForwarding($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
foreach ($result as $value) {
$values[$counter][“prefix”] = $value[“prefix”];
$values[$counter][“forwardto”] = $value[“forwardto”];
}
return $values;
}

Save Email Forwarding

The fred_SaveEmailForwarding function updates email forwarding settings.

function fred_SaveEmailForwarding($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
foreach ($params[“prefix”] as $key => $value) {
$forwardarray[$key][“prefix”] = $params[“prefix”][$key];
$forwardarray[$key][“forwardto”] = $params[“forwardto”][$key];
}
}

DNS Management

Get DNS Records

The fred_GetDNS function retrieves DNS records for a domain.

function fred_GetDNS($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
$hostrecords = array();
$hostrecords[] = array(“hostname” => “ns1”, “type” => “A”, “address” => “192.168.0.1”);
$hostrecords[] = array(“hostname” => “ns2”, “type” => “A”, “address” => “192.168.0.2”);
return $hostrecords;
}

Save DNS Records

The fred_SaveDNS function updates DNS records for a domain.

function fred_SaveDNS($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
foreach ($params[“dnsrecords”] as $key => $values) {
$hostname = $values[“hostname”];
$type = $values[“type”];
$address = $values[“address”];
}
$values[“error”] = $Enom->Values[“Err1”];
return $values;
}

Domain Registration

Register Domain

The fred_RegisterDomain function registers a new domain.

Domain Transfer

Transfer Domain

The fred_TransferDomain function transfers a domain to another registrar.

Domain Renewal

Renew Domain

The fred_RenewDomain function renews a domain for a specified period.

Contact Management

Get Contact Details

The fred_GetContactDetails function retrieves the contact details for a domain.

Save Contact Details

The fred_SaveContactDetails function updates the contact details for a domain.

Auth Code Retrieval

Get EPP Code

The fred_GetEPPCode function retrieves the EPP code for a domain transfer.

Nameserver Management

Register Nameserver

The fred_RegisterNameserver function registers a new nameserver.

function fred_RegisterNameserver($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
$nameserver = $params[“nameserver”];
$ipaddress = $params[“ipaddress”];
# Put your code to register the nameserver here
# If error, return the error message in the value below
$values[“error”] = $error;
return $values;
}

Modify Nameserver

The fred_ModifyNameserver function modifies the IP address of an existing nameserver.

phpCopy codefunction fred_ModifyNameserver($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
$nameserver = $params[“nameserver”];
$currentipaddress = $params[“currentipaddress”];
$newipaddress = $params[“newipaddress”];
# Put your code to update the nameserver here
# If error, return the error message in the value below
$values[“error”] = $error;
return $values;
}

Delete Nameserver

The fred_DeleteNameserver function deletes an existing nameserver.

phpCopy codefunction fred_DeleteNameserver($params) {
$username = $params[“Username”];
$password = $params[“Password”];
$testmode = $params[“TestMode”];
$tld = $params[“tld”];
$sld = $params[“sld”];
$nameserver = $params[“nameserver”];
# Put your code to delete the nameserver here
# If error, return the error message in the value below
$values[“error”] = $error;
return $values;
}

This documentation provides an overview of how the Free Registry for ENUM and Domains (FRED) API works, based on the provided domain operations code. Each function is designed to handle specific domain management tasks, such as registration, transfer, renewal, and contact management. The functions interact with the EPP (Extensible Provisioning Protocol) to perform these tasks and handle responses accordingly.