olssonm/loopia-api

Simple interface for the Loopia XMLRPC-API

Loopia API

A super simple wrapper for the Loopia XML RPC-API for PHP., _(*1)

Relies on lstrojny/fxmlrpc to make fast and efficient calls to the API. Requires PHP ^7.2 or PHP ^8.0., _(*2)

Installation

``` bash $ composer require olssonm/loopia-api, <sub>(*3)</sub>

## Usage

Using the package is straight forward – just include the client, create an instance and make your calls.

All methods are listed over at the [Loopia API-documentation](https://www.loopia.se/api/).

**Get all your domains**

``` php
    use Olssonm\LoopiaApi\Client;

    $response = (new Client('username', 'password'))
        ->getDomains()
        ->getResponse();

If needed, you may of course separate your code, like so:, <sub>(*4)</sub>

``` php use Olssonm\LoopiaApi\Client;, <sub>(*5)</sub>

$client = new Client('username', 'password');
$client->getDomains();
$response = $client->getResponse();

**Check the zone records for a domain (with subdomain)**

``` php
    use Olssonm\LoopiaApi\Client;

    $response = (new Client('username', 'password'))
        ->getZoneRecords('example.com', '@')
        ->getResponse();

Update your DNS (name)-servers, <sub>(*6)</sub>

``` php use Olssonm\LoopiaApi\Client;, <sub>(*7)</sub>

$response = (new Client('username', 'password'))
    ->updateDNSServers('example.com', ['ns1.loopia.se', 'ns2.loopia.se'])
    ->getResponse();

**Update your zone records**

``` php
    use Olssonm\LoopiaApi\Client;

    $response = (new Client('username', 'password'))
        ->updateZoneRecord('example.com', '@', [
            'type' => 'A',
            'ttl' => '3600',
            'priority' => 10,
            'rdata' => '74.125.0.0',
            'record_id' => 0
        ])
        ->getResponse();

Testing

Copy /tests/boot.example.php to /tests/boot.php and edit your settings. Then run:, <sub>(*8)</sub>

bash vendor/bin/phpunit --bootstrap ./tests/boot.php ./tests/LoopiaApiTests.php, <sub>(*9)</sub>

Of course the domain under testing needs to be owned by your Loopia account. Note: The last test (test_update_name_servers) actually modifies your name servers, use with caution., <sub>(*10)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>

© 2021 Marcus Olsson., <sub>(*12)</sub>