Domain Name API PHP Library

https://github.com/domainreseller/php-dna

Domain Name API PHP Library is a PHP library for domain management, supporting both SOAP and REST...

Tokens:118,168

Snippets:644

Trust Score:7.8

License:Apache-2.0

Update:6 days ago

Show doc for...

Tokens:

Tokens:

### Composer integration: install package and use autoload

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Installs the package via Composer and then loads it with the vendor autoloader. This is the recommended integration method.

```bash
composer require domainreseller/php-dna
```

--------------------------------

### Full client setup example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/domainnameapi-phplibrary.md

Shows a complete client initialization with OTE mode and configuration of the telemetry switches. The example disables Sentry error reporting, enables minimal telemetry payload, and keeps TLS verification on.

```php
$dna = new \DomainNameApi\DomainNameAPI_PHPLibrary($resellerId, $apiKey, true); // OTE
$dna->setErrorReportingEnabled(false);   // no Sentry
$dna->setTelemetryMinimal(true);         // minimal payload if reporting stays on
$dna->setSslVerification(true);         // keep TLS verification on
```

--------------------------------

### Get Domain List with GetList

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Retrieves a paginated list of domains. The example requests the first 1000 domains ordered by ID ascending. The sample output shows the structure of the returned array, including domain details, contacts, dates, nameservers, and child nameservers.

```php
$dna->GetList(['OrderColumn'=>'Id', 'OrderDirection'=>'ASC', 'PageNumber'=>0,'PageSize'=>1000]);
```

```php
Array
(
    [data] => Array
    (
        [Domains] => Array
        (
            [0] => Array
            (
                [ID] => 564346
                [Status] => Active
                [DomainName] => example.com
                [AuthCode] => DHQ!K52
                [LockStatus] => false
                [PrivacyProtectionStatus] => false
                [IsChildNameServer] => false
                [Contacts] => Array
                (
                    [Billing] => Array
                    (
                        [ID] => 11854114
                    )
                    [Technical] => Array
                    (
                        [ID] => 11854114
                    )
                    [Administrative] => Array
                    (
                        [ID] => 11854114
                    )
                    [Registrant] => Array
                    (
                        [ID] => 11854114
                    )
                )
                [Dates] => Array
                (
                    [Start] => 2024-03-15T10:00:00
                    [Expiration] => 2025-03-15T10:00:00
                    [RemainingDays] => 365
                )
                [NameServers] => Array
                (
                    [0] => ns1.example.com
                    [1] => ns2.example.com
                )
                [Additional] => Array
                (
                )
                [ChildNameServers] => Array
                (
                    [0] => Array
                    (
                        [ns] => ns1.example.com
                        [ip] => 1.2.3.4
                    )
                )
            )
        )
    )
    [result] => OK
    [TotalCount] => 1
)
```

--------------------------------

### Sample output for domain transfer

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Shows the response from Transfer, indicating a successful operation.

```php
Array
(
    [result] => OK
)
```

--------------------------------

### Composer integration: autoload and instantiate client

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Uses the Composer autoloader to include the library and then creates a client instance. This is the recommended integration method.

```php
require_once __DIR__.'/vendor/autoload.php';

$dna = new \DomainNameApi\DomainNameAPI_PHPLibrary($resellerId, $apiKey);
```

--------------------------------

### Initialize client with credentials and environment flag

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Creates the DomainNameAPI client with a Reseller ID and API key. Pass true as the third argument to use the test (OTE) environment instead of live.

```php
$resellerId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
$apiKey     = 'your-api-key';

// Live environment
$dna = new \DomainNameApi\DomainNameAPI_PHPLibrary($resellerId, $apiKey);

// Test (OTE) environment
$dna = new \DomainNameApi\DomainNameAPI_PHPLibrary($resellerId, $apiKey, true);
```

--------------------------------

### GetList

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Retrieves a list of domains from the reseller account. Accepts optional parameters for ordering, pagination, and page size.

```APIDOC
## GetList

### Description
Retrieves a list of domains from the reseller account. Accepts optional parameters for ordering, pagination, and page size.

### Method
PHP SDK Method

### Endpoint
`$dna->GetList()`

### Parameters
#### Optional Parameters (associative array)
- **OrderColumn** (string) - Optional - Column to order results by (e.g., 'Id')
- **OrderDirection** (string) - Optional - Sort direction: 'ASC' or 'DESC'
- **PageNumber** (integer) - Optional - Page number for pagination (0-based)
- **PageSize** (integer) - Optional - Number of records per page

### Request Example
```php
$dna->GetList(['OrderColumn'=>'Id', 'OrderDirection'=>'ASC', 'PageNumber'=>0,'PageSize'=>1000]);
```

### Response
#### Success Response
Returns an array with keys: `data` (containing domain details), `result` (status), and `TotalCount` (total number of domains).

#### Response Example
```php
Array
(
    [data] => Array
    (
        [Domains] => Array
        (
            [0] => Array
            (
                [ID] => 564346
                [Status] => Active
                [DomainName] => example.com
                [AuthCode] => DHQ!K52
                [LockStatus] => false
                [PrivacyProtectionStatus] => false
                [IsChildNameServer] => false
                [Contacts] => Array
                (
                    [Billing] => Array
                    (
                        [ID] => 11854114
                    )
                    [Technical] => Array
                    (
                        [ID] => 11854114
                    )
                    [Administrative] => Array
                    (
                        [ID] => 11854114
                    )
                    [Registrant] => Array
                    (
                        [ID] => 11854114
                    )
                )
                [Dates] => Array
                (
                    [Start] => 2024-03-15T10:00:00
                    [Expiration] => 2025-03-15T10:00:00
                    [RemainingDays] => 365
                )
                [NameServers] => Array
                (
                    [0] => ns1.example.com
                    [1] => ns2.example.com
                )
                [Additional] => Array
                (
                )
                [ChildNameServers] => Array
                (
                    [0] => Array
                    (
                        [ns] => ns1.example.com
                        [ip] => 1.2.3.4
                    )
                )
            )
        )
    )
    [result] => OK
    [TotalCount] => 1
)
```
```

--------------------------------

### Sample output for domain renewal

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Shows the response from Renew, containing the updated expiration date.

```php
Array
(
    [result] => OK
    [data] => Array
    (
        [ExpirationDate] => 2025-03-15T10:00:00
    )
)
```

--------------------------------

### Get TLD List with GetTldList

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Fetches the list of supported top-level domains (TLDs). The parameter 100 likely limits the number of TLDs returned. The sample output shows TLD details including pricing and currency information.

```php
$dna->GetTldList(100);
```

```php
Array
(
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 1
                    [status] => Active
                    [maxchar] => 63
                    [maxperiod] => 10
                    [minchar] => 1
                    [minperiod] => 1
                    [tld] => com
                    [pricing] => Array
                        (
                            [registration] => Array
                                (
                                    [1] => 10.8100
                                )
                            [renew] => Array
                                (
                                    [1] => 11.0100
                                )
                            [transfer] => Array
                                (
                                    [1] => 10.6100
                                )
                            [restore] => Array
                                (
                                    [1] => 99.9000
                                )
                        )
                    [currencies] => Array
                        (
                            [registration] => USD
                            [renew] => USD
                            [transfer] => USD
                            [restore] => USD
                        )
                )
        )
    [result] => OK
)
```

--------------------------------

### AddChildNameServer

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Adds a child nameserver to a domain with an associated IP address.

```APIDOC
## AddChildNameServer

### Description
Adds a child nameserver to a domain with an associated IP address.

### Method
PHP SDK Method

### Endpoint
`$dna->AddChildNameServer('example.com', 'ns1.example.com', '1.2.3.4')`

### Parameters
- **domain** (string) - Required - The domain name.
- **nameserver** (string) - Required - The hostname of the child nameserver.
- **ip** (string) - Required - The IP address for the child nameserver.

### Request Example
```php
$dna->AddChildNameServer('example.com', 'ns1.example.com', '1.2.3.4');
```

### Response
#### Success Response
- **data** (array) - Contains the added nameserver and its IP addresses.
  - **NameServer** (string) - The hostname of the child nameserver.
  - **IPAdresses** (array) - List of IP addresses.
- **result** (string) - Status of the operation (e.g., OK).

#### Response Example
```php
Array
(
    [data] => Array
        (
            [NameServer] => ns1.example.com
            [IPAdresses] => Array
                (
                    [0] => 1.2.3.4
                )
        )
    [result] => OK
)
```
```

--------------------------------

### Manual usage: require library file and instantiate client

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Loads the library directly from the downloaded files without Composer. Requires the DomainNameAPI_PHPLibrary.php file and then creates a client instance.

```php
require_once __DIR__.'/DomainNameApi/DomainNameAPI_PHPLibrary.php';

$dna = new \DomainNameApi\DomainNameAPI_PHPLibrary($resellerId, $apiKey);
```

--------------------------------

### addResourceRecord basic call example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-dns.md

Example of adding an A record for 'www' with content '192.0.2.10'. Checks result and prints confirmation.

```php
$result = $dna->addResourceRecord('example.com', 'www', 'A', '192.0.2.10');
if ($result['result'] === 'OK') {
    echo "Record staged and applied: {$result['data']['Name']} {$result['data']['Type']}\n";
}
```

--------------------------------

### Sample output for domain registration

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Shows the expected response from RegisterWithContactInfo, including domain ID, status, auth code, lock status, privacy protection, contact IDs, dates, name servers, and empty additional and child name server arrays.

```php
Array
(
    [result] => OK
    [data] => Array
    (
        [ID] => 123456
        [Status] => clientTransferProhibited
        [DomainName] => example.com
        [AuthCode] => Xy9#mK2$pL5@vN8
        [LockStatus] => true
        [PrivacyProtectionStatus] => false
        [IsChildNameServer] => false
        [Contacts] => Array
        (
            [Billing] => Array
            (
                [ID] => 987654
            )
            [Technical] => Array
            (
                [ID] => 987654
            )
            [Administrative] => Array
            (
                [ID] => 987654
            )
            [Registrant] => Array
            (
                [ID] => 987654
            )
        )
        [Dates] => Array
        (
            [Start] => 2024-03-15T10:00:00
            [Expiration] => 2025-03-15T10:00:00
            [RemainingDays] => 365
        )
        [NameServers] => Array
        (
            [0] => ns1.example.com
            [1] => ns2.example.com
        )
        [Additional] => Array
        (
        )
        [ChildNameServers] => Array
        (
        )
    )
)
```

--------------------------------

### DeleteChildNameServer

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Deletes a child nameserver from a domain.

```APIDOC
## DeleteChildNameServer

### Description
Deletes a child nameserver from a domain.

### Method
PHP SDK Method

### Endpoint
`$dna->DeleteChildNameServer('example.com', 'ns1.example.com')`

### Parameters
- **domain** (string) - Required - The domain name.
- **nameserver** (string) - Required - The hostname of the child nameserver to delete.

### Request Example
```php
$dna->DeleteChildNameServer('example.com', 'ns1.example.com');
```

### Response
#### Success Response
- **data** (array) - Contains the deleted nameserver.
  - **NameServer** (string) - The hostname of the deleted child nameserver.
- **result** (string) - Status of the operation (e.g., OK).

#### Response Example
```php
Array
(
    [data] => Array
        (
            [NameServer] => ns1.example.com
        )
    [result] => OK
)
```
```

--------------------------------

### Get Domain Details with GetDetails

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Retrieves detailed information for a domain, including status, auth code, lock status, contacts, dates, nameservers, and child nameservers. The output shows a sample response with result OK.

```php
$dna->GetDetails('example.com');
```

```php
Array
(
    [data] => Array
        (
            [ID] => 564346
            [Status] => Active
            [DomainName] => example.com
            [AuthCode] => DHQ!K52
            [LockStatus] => true
            [PrivacyProtectionStatus] => false
            [IsChildNameServer] => false
            [Contacts] => Array
                (
                    [Billing] => Array
                        (
                            [ID] => 11854114
                        )
                    [Technical] => Array
                        (
                            [ID] => 11854114
                        )
                    [Administrative] => Array
                        (
                            [ID] => 11854114
                        )
                    [Registrant] => Array
                        (
                            [ID] => 11854114
                        )
                )
            [Dates] => Array
                (
                    [Start] => 2025-05-26T16:08:37
                    [Expiration] => 2027-05-26T16:08:37
                    [RemainingDays] => 449
                )
            [NameServers] => Array
                (
                    [0] => ns1.example.com
                    [1] => ns2.example.com
                )
            [Additional] => Array
                (
                )
            [ChildNameServers] => Array
                (
                    [0] => Array
                        (
                            [ns] => ns1.example.com
                            [ip] => 1.2.3.4
                        )
                )
        )
    [result] => OK
)
```

--------------------------------

### EnableTheftProtectionLock

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Enables the theft protection lock on a domain to prevent unauthorized transfers.

```APIDOC
## EnableTheftProtectionLock

### Description
Enables the theft protection lock on a domain to prevent unauthorized transfers.

### Method
PHP SDK Method

### Endpoint
`$dna->EnableTheftProtectionLock('example.com')`

### Parameters
- **domain** (string) - Required - The domain name to lock.

### Request Example
```php
$dna->EnableTheftProtectionLock('example.com');
```

### Response
#### Success Response
- **data** (array) - Contains the lock status.
  - **LockStatus** (boolean) - Whether the lock is enabled.
- **result** (string) - Status of the operation (e.g., OK).

#### Response Example
```php
Array
(
    [data] => Array
        (
            [LockStatus] => true
        )
    [result] => OK
)
```
```

--------------------------------

### GetDetails

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Retrieves detailed information about a domain, including status, contacts, dates, nameservers, and child nameservers.

```APIDOC
## GetDetails

### Description
Retrieves detailed information about a domain, including status, contacts, dates, nameservers, and child nameservers.

### Method
PHP SDK Method

### Endpoint
`$dna->GetDetails('example.com')`

### Parameters
- **domain** (string) - Required - The domain name to get details for.

### Request Example
```php
$dna->GetDetails('example.com');
```

### Response
#### Success Response
- **data** (array) - Contains domain details.
  - **ID** (integer) - Domain ID.
  - **Status** (string) - Domain status.
  - **DomainName** (string) - Domain name.
  - **AuthCode** (string) - Authorization code.
  - **LockStatus** (boolean) - Whether the domain is locked.
  - **PrivacyProtectionStatus** (boolean) - Whether privacy protection is enabled.
  - **IsChildNameServer** (boolean) - Whether child nameservers are used.
  - **Contacts** (array) - Contact IDs for billing, technical, administrative, and registrant.
  - **Dates** (array) - Start, expiration, and remaining days.
  - **NameServers** (array) - List of nameservers.
  - **Additional** (array) - Additional data.
  - **ChildNameServers** (array) - List of child nameservers with ns and ip.
- **result** (string) - Status of the operation (e.g., OK).

#### Response Example
```php
Array
(
    [data] => Array
        (
            [ID] => 564346
            [Status] => Active
            [DomainName] => example.com
            [AuthCode] => DHQ!K52
            [LockStatus] => true
            [PrivacyProtectionStatus] => false
            [IsChildNameServer] => false
            [Contacts] => Array
                (
                    [Billing] => Array
                        (
                            [ID] => 11854114
                        )
                    [Technical] => Array
                        (
                            [ID] => 11854114
                        )
                    [Administrative] => Array
                        (
                            [ID] => 11854114
                        )
                    [Registrant] => Array
                        (
                            [ID] => 11854114
                        )
                )
            [Dates] => Array
                (
                    [Start] => 2025-05-26T16:08:37
                    [Expiration] => 2027-05-26T16:08:37
                    [RemainingDays] => 449
                )
            [NameServers] => Array
                (
                    [0] => ns1.example.com
                    [1] => ns2.example.com
                )
            [Additional] => Array
                (
                )
            [ChildNameServers] => Array
                (
                    [0] => Array
                        (
                            [ns] => ns1.example.com
                            [ip] => 1.2.3.4
                        )
                )
        )
    [result] => OK
)
```
```

--------------------------------

### GetTldList

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Retrieves a list of supported top-level domains (TLDs) with their pricing and configuration. Accepts an optional parameter for the number of TLDs to return.

```APIDOC
## GetTldList

### Description
Retrieves a list of supported top-level domains (TLDs) with their pricing and configuration. Accepts an optional parameter for the number of TLDs to return.

### Method
PHP SDK Method

### Endpoint
`$dna->GetTldList()`

### Parameters
#### Optional Parameters
- **limit** (integer) - Optional - Maximum number of TLDs to return

### Request Example
```php
$dna->GetTldList(100);
```

### Response
#### Success Response
Returns an array with keys: `data` (array of TLD objects) and `result` (status). Each TLD object contains `id`, `status`, `maxchar`, `maxperiod`, `minchar`, `minperiod`, `tld`, `pricing`, and `currencies`.

#### Response Example
```php
Array
(
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 1
                    [status] => Active
                    [maxchar] => 63
                    [maxperiod] => 10
                    [minchar] => 1
                    [minperiod] => 1
                    [tld] => com
                    [pricing] => Array
                        (
                            [registration] => Array
                                (
                                    [1] => 10.8100
                                )
                            [renew] => Array
                                (
                                    [1] => 11.0100
                                )
                            [transfer] => Array
                                (
                                    [1] => 10.6100
                                )
                            [restore] => Array
                                (
                                    [1] => 99.9000
                                )
                        )
                    [currencies] => Array
                        (
                            [registration] => USD
                            [renew] => USD
                            [transfer] => USD
                            [restore] => USD
                        )
                )
        )
    [result] => OK
)
```
```

--------------------------------

### ModifyNameServer

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Modifies the nameservers for a domain by providing a list of new nameservers.

```APIDOC
## ModifyNameServer

### Description
Modifies the nameservers for a domain by providing a list of new nameservers.

### Method
PHP SDK Method

### Endpoint
`$dna->ModifyNameServer('example.com', ['ns1.example.com', 'ns2.example.com'])`

### Parameters
- **domain** (string) - Required - The domain name to modify.
- **nameservers** (array) - Required - List of nameserver hostnames.

### Request Example
```php
$dna->ModifyNameServer('example.com', ['ns1.example.com', 'ns2.example.com']);
```

### Response
#### Success Response
- **data** (array) - Contains the updated nameservers.
  - **NameServers** (array) - List of nameservers.
- **result** (string) - Status of the operation (e.g., OK).

#### Response Example
```php
Array
(
    [data] => Array
        (
            [NameServers] => Array
                (
                    [0] => ns1.example.com
                    [1] => ns2.example.com
                )
        )
    [result] => OK
)
```
```

--------------------------------

### Basic call with pagination example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-account.md

Example of calling getList with pagination parameters and processing the result. Checks for 'OK' result and iterates over domains.

```php
$result = $dna->getList(['OrderColumn' => 'Id', 'OrderDirection' => 'ASC',
                         'PageNumber' => 0, 'PageSize' => 1000]);
if ($result['result'] === 'OK') {
    echo "Total: {$result['TotalCount']}\n";
    foreach ($result['data']['Domains'] as $d) {
        echo $d['DomainName'] . ' — ' . $d['Status'] . ' — expires ' . $d['Dates']['Expiration'] . PHP_EOL;
    }
} else {
    echo $result['error']['Message'];
}
```

--------------------------------

### DisableTheftProtectionLock

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Disables the theft protection lock on a domain, allowing transfers.

```APIDOC
## DisableTheftProtectionLock

### Description
Disables the theft protection lock on a domain, allowing transfers.

### Method
PHP SDK Method

### Endpoint
`$dna->DisableTheftProtectionLock('example.com')`

### Parameters
- **domain** (string) - Required - The domain name to unlock.

### Request Example
```php
$dna->DisableTheftProtectionLock('example.com');
```

### Response
#### Success Response
- **data** (array) - Contains the lock status.
  - **LockStatus** (boolean) - Whether the lock is disabled.
- **result** (string) - Status of the operation (e.g., OK).

#### Response Example
```php
Array
(
    [data] => Array
        (
            [LockStatus] => false
        )
    [result] => OK
)
```
```

--------------------------------

### Example: Using getResellerDetails

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-account.md

Example usage of getResellerDetails. Instantiates the library with reseller ID and API key, calls the method, and prints account name, balance, and currency. Checks for 'OK' result and handles error message.

```php
$dna = new \DomainNameApi\DomainNameAPI_PHPLibrary($resellerId, $apiKey);
$details = $dna->getResellerDetails();
if ($details['result'] === 'OK') {
    echo $details['name'] . ' balance: ' . $details['balance'] . ' ' . $details['currency'] . PHP_EOL;
    foreach ($details['balances'] as $b) {
        echo $b['currency'] . ': ' . $b['balance'] . PHP_EOL; // USD and TL
    }
} else {
    echo $details['error']['Message'];
}
```

--------------------------------

### CheckAvailability

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Checks the availability of domain names for specified TLDs. Accepts domain names, TLDs, registration period, and command type.

```APIDOC
## CheckAvailability

### Description
Checks the availability of domain names for specified TLDs. Accepts domain names, TLDs, registration period, and command type.

### Method
PHP SDK Method

### Endpoint
`$dna->CheckAvailability()`

### Parameters
#### Required Parameters
- **domains** (array of strings) - Required - List of domain names to check (without TLD)
- **tlds** (array of strings) - Required - List of TLDs to check against
- **period** (integer) - Required - Registration period in years
- **command** (string) - Required - Command type (e.g., 'create')

### Request Example
```php
$dna->CheckAvailability(['hello','world123x0'], ['com','net'], 1, 'create');
```

### Response
#### Success Response
Returns an array of availability results, each containing `TLD`, `DomainName`, `Status`, `Command`, `Period`, `IsFee`, `Price`, `Currency`, and `Reason`.

#### Response Example
```php
Array
(
    [0] => Array
        (
            [TLD] => com
            [DomainName] => hello
            [Status] => notavailable
            [Command] => create
            [Period] => 1
            [IsFee] =>
            [Price] => 10.8100
            [Currency] => USD
            [Reason] => Domain exists
        )

    [1] => Array
        (
            [TLD] => com
            [DomainName] => world123x0
            [Status] => available
            [Command] => create
            [Period] => 1
            [IsFee] =>
            [Price] => 10.8100
            [Currency] => USD
            [Reason] =>
        )
)
```
```

--------------------------------

### Add Child Nameserver with AddChildNameServer

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Adds a child nameserver to a domain with the specified IP address. The sample output shows the nameserver and its IP address, with result OK.

```php
$dna->AddChildNameServer('example.com', 'ns1.example.com', '1.2.3.4');
```

```php
Array
(
    [data] => Array
        (
            [NameServer] => ns1.example.com
            [IPAdresses] => Array
                (
                    [0] => 1.2.3.4
                )
        )
    [result] => OK
)
```

--------------------------------

### addResourceRecord staged write with error handling

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-dns.md

Example of staging an MX record with apply=false, then applying later. Includes error handling for both stages.

```php
$result = $dna->addResourceRecord('example.com', '', 'MX', '10 mail.example.com', 3600, false); // stage only
if ($result['result'] === 'ERROR') {
    echo $result['error']['Message'];
} else {
    $applied = $dna->applyResourceRecords('example.com'); // commit
    echo $applied['result'] === 'OK' ? 'Zone applied' : $applied['error']['Message'];
}
```

--------------------------------

### GET products/tlds

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/endpoints.md

Retrieves a list of supported TLDs with their constraints and pricing. Supports pagination via MaxResultCount and SkipCount parameters.

```APIDOC
## GET products/tlds

### Description
Retrieves a list of supported TLDs with their constraints and pricing. Supports pagination via MaxResultCount and SkipCount parameters.

### Method
GET

### Endpoint
products/tlds

### Parameters
#### Query Parameters
- **MaxResultCount** (integer) - Optional - Maximum number of results to return.
- **SkipCount** (integer) - Optional - Number of results to skip (default 0).

### Response
#### Success Response (200)
- **items[]** (array) - List of TLD items.
  - **status** (string) - TLD status.
  - **constraints.maxLenght** (integer) - Maximum length (sic).
  - **maxRegistrationPeriod** (integer) - Maximum registration period.
  - **constraints.minLength** (integer) - Minimum length.
  - **minRegistrationPeriod** (integer) - Minimum registration period.
  - **name** (string) - TLD name.
  - **prices[0]** (object) - Pricing information.
    - **register** (array/object) - Registration price.
    - **renew** (array/object) - Renewal price.
    - **transfer** (array/object) - Transfer price.
    - **restore** (array/object) - Restore price.
    - **refund** (array/object) - Refund price.
    - **backorder** (array/object) - Backorder price.
    - Each price object contains: **period** (integer), **price** (number), **currency** (string).

#### Response Example
{
  "items": [
    {
      "status": "active",
      "constraints": {"maxLenght": 63, "minLength": 1},
      "maxRegistrationPeriod": 10,
      "minRegistrationPeriod": 1,
      "name": "com",
      "prices": [{"register": {"period": 1, "price": 10.00, "currency": "USD"}}]
    }
  ]
}
```

--------------------------------

### Test Setup: .env.test Configuration

Source: https://github.com/domainreseller/php-dna/blob/main/README-CN.md

Environment configuration file for running PHPUnit tests. Contains reseller ID, API key, and domain names used by the test suite.

```env
DNA_RESELLER_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
DNA_API_KEY=your-api-key
DNA_DOMAIN=yourdomain.com
DNA_DOMAIN_CONTACTS=yourdomain-with-contacts.com
```

--------------------------------

### Transfer a domain

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Calls the Transfer method with the domain name, auth code, and a period of 3 years. The sample output shows a successful result.

```php
$dna->Transfer('example.com', 'Xy9#mK2$', 3);
```

--------------------------------

### Check Domain Availability with CheckAvailability

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Checks availability for multiple domains across specified TLDs. The parameters specify domain names, TLDs, registration period, and command type. The sample output shows availability status, pricing, and reason for unavailability.

```php
$dna->CheckAvailability(['hello','world123x0'], ['com','net'], 1, 'create');
```

```php
Array
(
    [0] => Array
        (
            [TLD] => com
            [DomainName] => hello
            [Status] => notavailable
            [Command] => create
            [Period] => 1
            [IsFee] =>
            [Price] => 10.8100
            [Currency] => USD
            [Reason] => Domain exists
        )

    [1] => Array
        (
            [TLD] => com
            [DomainName] => world123x0
            [Status] => available
            [Command] => create
            [Period] => 1
            [IsFee] =>
            [Price] => 10.8100
            [Currency] => USD
            [Reason] =>
        )
)
```

--------------------------------

### RegisterWithContactInfo

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Registers a new domain with contact information and optional additional attributes for .tr domains. Returns registration details including domain ID, status, auth code, and contact IDs.

```APIDOC
## RegisterWithContactInfo

### Description
Registers a new domain with contact information and optional additional attributes for .tr domains. Returns registration details including domain ID, status, auth code, and contact IDs.

### Method
RegisterWithContactInfo

### Endpoint
$dna->RegisterWithContactInfo(domainName, period, contacts, nameServers, lockStatus, privacyProtection, additionalAttributes)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **domainName** (string) - Required - The domain name to register (e.g., 'example.com')
- **period** (integer) - Required - Registration period in years (e.g., 1)
- **contacts** (array) - Required - Associative array with keys 'Administrative', 'Billing', 'Technical', 'Registrant', each containing contact details
- **nameServers** (array) - Required - Array of nameserver strings (e.g., ["ns1.example.com", "ns2.example.com"])
- **lockStatus** (boolean) - Required - Whether to lock the domain (true/false)
- **privacyProtection** (boolean) - Required - Whether to enable privacy protection (true/false)
- **additionalAttributes** (array) - Optional - Additional attributes required for .tr domains (e.g., TRABISDOMAINCATEGORY, TRABISCITIZIENID, etc.)

### Request Example
```php
$contact = [
    "FirstName"        => 'John',
    "LastName"         => 'Doe',
    "Company"          => 'Example Corp',
    "EMail"            => 'john.doe@example.com',
    "AddressLine1"     => '123 Lorem Street',
    "AddressLine2"     => 'Suite 456',
    "AddressLine3"     => '',
    "City"             => 'Springfield',
    "Country"          => 'US',
    "Fax"              => '1234567890',
    "FaxCountryCode"   => '1',
    "Phone"            => '9876543210',
    "PhoneCountryCode" => 1,
    "Type"             => 'Contact',
    "ZipCode"          => '12345',
    "State"            => 'IL'
];

$dna->RegisterWithContactInfo(
    'example.com',
    1,
    [
        'Administrative' => $contact,
        'Billing'        => $contact,
        'Technical'      => $contact,
        'Registrant'     => $contact
    ],
    ["ns1.example.com", "ns2.example.com"],
    true,
    false,
    [
        'TRABISDOMAINCATEGORY' => 1,
        'TRABISCITIZIENID'     => '12345678901',
        'TRABISNAMESURNAME'    => 'John Doe',
        'TRABISCOUNTRYID'      => '840',
        'TRABISCITYID'         => '17'
    ]
);
```

### Response
#### Success Response (200)
- **result** (string) - Status of the operation (e.g., 'OK')
- **data** (array) - Contains registration details:
  - **ID** (integer) - Domain ID
  - **Status** (string) - Domain status (e.g., 'clientTransferProhibited')
  - **DomainName** (string) - The registered domain name
  - **AuthCode** (string) - Authorization code for the domain
  - **LockStatus** (boolean) - Whether the domain is locked
  - **PrivacyProtectionStatus** (boolean) - Whether privacy protection is enabled
  - **IsChildNameServer** (boolean) - Whether child nameservers are used
  - **Contacts** (array) - Contact IDs for Billing, Technical, Administrative, Registrant
  - **Dates** (array) - Start, Expiration, RemainingDays
  - **NameServers** (array) - List of nameservers
  - **Additional** (array) - Additional attributes (empty if none)
  - **ChildNameServers** (array) - Child nameservers (empty if none)

#### Response Example
```php
Array
(
    [result] => OK
    [data] => Array
    (
        [ID] => 123456
        [Status] => clientTransferProhibited
        [DomainName] => example.com
        [AuthCode] => Xy9#mK2$pL5@vN8
        [LockStatus] => true
        [PrivacyProtectionStatus] => false
        [IsChildNameServer] => false
        [Contacts] => Array
        (
            [Billing] => Array
            (
                [ID] => 987654
            )
            [Technical] => Array
            (
                [ID] => 987654
            )
            [Administrative] => Array
            (
                [ID] => 987654
            )
            [Registrant] => Array
            (
                [ID] => 987654
            )
        )
        [Dates] => Array
        (
            [Start] => 2024-03-15T10:00:00
            [Expiration] => 2025-03-15T10:00:00
            [RemainingDays] => 365
        )
        [NameServers] => Array
        (
            [0] => ns1.example.com
            [1] => ns2.example.com
        )
        [Additional] => Array
        (
        )
        [ChildNameServers] => Array
        (
        )
    )
)
```

```

--------------------------------

### Basic getTldList call example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-account.md

Basic usage of getTldList with count 50. Iterates over returned TLDs and prints registration price for 1-year period.

```php
$result = $dna->getTldList(50);
if ($result['result'] === 'OK') {
    foreach ($result['data'] as $tld) {
        $reg = $tld['pricing']['registration'][1] ?? 'n/a';
        echo $tld['tld'] . " (min {$tld['minperiod']}y, max {$tld['maxperiod']}y): 1y register = {$reg}\n";
    }
}
```

--------------------------------

### Basic registration with contacts example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-transfers.md

Example of registering a domain with contact information. Uses a contact array with fields like FirstName, LastName, EMail, etc. Calls registerWithContactInfo with nameservers and flags. Checks result and prints success or error.

```php
$contact = [
    "FirstName" => 'John', "LastName" => 'Doe', "Company" => 'Example Corp',
    "EMail" => 'john.doe@example.com', "AddressLine1" => '123 Lorem Street',
    "City" => 'Springfield', "Country" => 'US', "State" => 'IL',
    "ZipCode" => '12345', "Phone" => '9876543210', "PhoneCountryCode" => 1,
    "Fax" => '1234567890', "FaxCountryCode" => '1', "Type" => 'Contact',
];

$result = $dna->registerWithContactInfo(
    'example.com', 1,
    ['Administrative' => $contact, 'Billing' => $contact,
     'Technical' => $contact, 'Registrant' => $contact],
    ["ns1.example.com", "ns2.example.com"],
    true,   // eppLock
    false,  // privacyLock
    []      // tldAttributes
);

if ($result['result'] === 'OK') {
    echo "Registered {$result['data']['DomainName']} (ID {$result['data']['ID']})\n";
} else {
    printf("%s: %s\n%s\n", $result['error']['Code'], $result['error']['Message'], $result['error']['Details']);
}
```

--------------------------------

### deleteForwarding usage example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-dns.md

Calls `deleteForwarding('example.com')` and checks the result to confirm the forwarding was removed, otherwise prints the error details.

```php
$result = $dna->deleteForwarding('example.com');
echo $result['result'] === 'OK' ? 'Forwarding removed' : $result['error']['Details'];
```

--------------------------------

### Modify Nameservers with ModifyNameServer

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Updates the nameservers for a domain by providing an array of nameserver strings. The sample output confirms the new nameservers and returns result OK.

```php
$dna->ModifyNameServer('example.com', ['ns1.example.com', 'ns2.example.com']);
```

```php
Array
(
    [data] => Array
        (
            [NameServers] => Array
                (
                    [0] => ns1.example.com
                    [1] => ns2.example.com
                )
        )
    [result] => OK
)
```

--------------------------------

### Enable Domain Lock with EnableTheftProtectionLock

Source: https://github.com/domainreseller/php-dna/blob/main/README.md

Enables the theft protection lock for a domain. The sample output shows LockStatus set to true and result OK.

```php
$dna->EnableTheftProtectionLock('example.com');
```

```php
Array
(
    [data] => Array
        (
            [LockStatus] => true
        )
    [result] => OK
)
```

--------------------------------

### getResourceRecords usage example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-dns.md

Example of calling getResourceRecords and iterating over the returned records. Prints each record's Name, Type, TTL, and Content.

```php
$result = $dna->getResourceRecords('example.com');
if ($result['result'] === 'OK') {
    foreach ($result['data']['records'] as $rec) {
        printf("%-30s %-6s %5d  %s\n", $rec['Name'], $rec['Type'], $rec['TTL'], $rec['Content']);
    }
}
```

--------------------------------

### Basic checkAvailability call example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-account.md

Demonstrates a basic call to checkAvailability with two domains and two extensions, iterating over the result rows to print availability status and price.

```php
$result = $dna->checkAvailability(['example', 'test'], ['com', 'net'], 1);
foreach ($result as $row) {
    printf("%s.%s is %s (price: %s %s)\n",
        $row['DomainName'], $row['TLD'], $row['Status'],
        $row['Price'] ?? 'n/a', $row['Currency'] ?? '');
}
```

--------------------------------

### syncFromRegistry usage example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-domain-ops.md

Example call to syncFromRegistry. Checks result and echoes Status from data.

```php
$result = $dna->syncFromRegistry('example.com');
if ($result['result'] === 'OK') {
    echo $result['data']['Status'];
}
```

--------------------------------

### transfer example

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-transfers.md

Example of initiating a transfer for 'example.com' with an EPP code and 3-year period. Checks result and prints status or error message.

```php
$result = $dna->transfer('example.com', 'Xy9#mK2$', 3);
if ($result['result'] === 'OK') {
    echo "Transfer initiated; status: {$result['data']['Status']}\n";
} else {
    // e.g. "Auth code is not valid." (API_591) surfaced through the envelope
    echo $result['error']['Message'];
}
```

--------------------------------

### Require legacy PHP library file

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/index.md

Alternative to Composer installation: directly require the legacy PHP library file. This is an alternative installation method.

```php
require DomainNameApi/DomainNameAPI_PHPLibrary.php
```

--------------------------------

### Example — add child nameserver

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/api-reference/dnarest-domain-ops.md

Adds a child nameserver and checks the result. On success, prints the nameserver and its IP addresses.

```php
$result = $dna->addChildNameServer('example.com', 'ns1child.example.com', '192.0.2.10');
if ($result['result'] === 'OK') {
    echo "Added {$result['data']['NameServer']} -> " . implode(', ', $result['data']['IPAdresses']) . PHP_EOL;
}
```

--------------------------------

### DNARest constructor

Source: https://github.com/domainreseller/php-dna/blob/main/_autodocs/configuration.md

Constructor for the direct client. Requires reseller ID and token; test mode is optional and not string-coerced.

```php
public function __construct($resellerId, $token, $testmode = false)
```